Skip to content

SubFile::Name property

The Name property displays name of the sub-document, if available.

string Name { get; }

string getName() throws IGRException;

@property
def Name(self) -> string

std::wstring getName() const;

[propget] HRESULT Name([out, retval] BSTR *result);

Return Value

string : The name of the subfile.

Sample Code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
using Hyland.DocumentFilters;

var api = new Hyland.DocumentFilters.Api();
api.Initialize("License Code", ".");

using var doc = api.GetExtractor("filename.zip");
doc.Open(Hyland.DocumentFilters.OpenType.BodyAndMeta);

foreach (var subfile in doc.SubFiles)
{
    using (subfile)
    {
        // act on subfile
        Console.Out.WriteLine("Name: " + subFile.Name);
        Console.Out.WriteLine("ID: " + subFile.ID);
        Console.Out.WriteLine("Date: " + subFile.FileDate);
        Console.Out.WriteLine("Size: " + subFile.FileSize);        
    } 
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
import com.perceptive.documentfilters.*;

public class App
{
    public static void main(String[] args) throws Exception
    {
        DocumentFilters df = new DocumentFilters();
        df.Initialize("License Code", ".");

        try (Extractor doc = df.GetExtractor("filename.zip")) {
            doc.Open(isys_docfilters.IGR_BODY_AND_META);

            for (SubFile subfile = doc.GetFirstSubFile(); subfile != null; subfile = doc.GetNextSubFile())
            {
                try (subfile) {
                    // act on subfile
                }
            }
        }
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from DocumentFilters import *

api = DocumentFilters()
api.Initialize("License Code", ".")

with api.GetExtractor("filename.zip") as doc:
    doc.Open(IGR_BODY_AND_META, "")

    for subfile in doc.SubFiles:
        with subfile:
            # act on subfile

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#include <DocumentFiltersObjects.h>
#include <iostream>

using namespace Hyland::DocFilters;

int main() {
    try {
        // Initialize the Document Filters API
        Hyland::DocFilters::DocumentFilters api; 
        api.Initialize("License Code", "."); 

        // Get the extractor
        Hyland::DocFilters::Extractor doc = api.GetExtractor("filename.zip");

        // Open the document
        doc.Open(Hyland::DocFilters::OpenMode::Text, IGR_BODY_AND_META);

        // Access subfiles using the subfiles() iterator
        for (auto subfile : doc.subfiles()) {
            try {
                // Process the subfile
                std::wcout << L"Name: " << subfile.getName() << std::endl;
                std::wcout << L"ID: " << subfile.getId() << std::endl;
                std::wcout << L"Date: " << u8_to_w(subfile.getFileDate().ToIsoString()) << std::endl;
                std::wcout << L"Size: " << subfile.getSize() << std::endl;
            } catch (const std::exception& e) {
                std::cerr << "Error: " << e.what() << std::endl;
            }
        }

        // Close the extractor
        doc.Close(); 
    } catch (const std::exception& e) {
        std::cerr << "Error: " << e.what() << std::endl;
    }

    return 0;
}

See Also