Skip to content

IGROption interface

Represents a configuration option as returned by GetAvailableOptions.

IGROption::DefaultValue property

Gets the default value of the option.

IGROption::Description property

Gets the description of the option.

IGROption::DisplayName property

Gets the display name of the option.

IGROption::Flags property

Gets the flags of the option.

IGROption::PossibleValues property

Gets the possible values of the option.

IGROption::Type property

Gets the type of the option.

Sample Code

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

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

// Call the GetAvailableOptions method
IEnumerable<Option> availableOptions = api.GetAvailableOptions();

// Iterate over the available options and print their details
foreach (Option option in availableOptions) {
    Console.WriteLine("Option Display Name: " + option.DisplayName);
    Console.WriteLine("Option Description: " + option.Description);
    Console.WriteLine("Option Default Value: " + option.DefaultValue);
    Console.WriteLine("Option Type: " + option.Type);
    Console.WriteLine("Option Flags: " + option.Flags);
    Console.WriteLine("Option Possible Values: " + string.Join(", ", option.PossibleValues));
    Console.WriteLine();
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
import com.perceptive.documentfilters.*;

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

        // Call the GetAvailableOptions method
        VectIGROption availableOptions = df.GetAvailableOptions();

        // Iterate over the available options and print their details
        for (int i = 0; i < availableOptions.size(); i++) {
            IGROption option = availableOptions.get(i);
            System.out.println("Option Display Name: " + option.GetDisplayName());
            System.out.println("Option Description: " + option.GetDescription());
            System.out.println("Option Default Value: " + option.GetDefaultValue());
            System.out.println("Option Type: " + option.GetType());
            System.out.println("Option Flags: " + option.GetFlags());
            System.out.println("Option Possible Values: " + option.GetPossibleValuesStr());
            System.out.println();
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from DocumentFilters import *

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

# Call the getAvailableOptions method
available_options = df.GetAvailableOptions()

# Iterate over the available options and print their details
for option in available_options:
    print("Option Display Name:", option.DisplayName)
    print("Option Description:", option.Description)
    print("Option Default Value:", option.DefaultValue)
    print("Option Type:", option.Type)
    print("Option Flags:", option.Flags)
    print("Option Possible Values:", option.PossibleValues)
    print()
 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
#include <DocumentFiltersObjects.h>

int main(int argc, char** argv) {
    Hyland::DocFilters::DocumentFilters df;
    df.Initialize("License Code", ".");

    // Call the getAvailableOptions method
    const std::vector<Hyland::DocFilters::Option>& availableOptions = df.getAvailableOptions();

    // Iterate over the available options and print their details
    for (const auto& option : availableOptions) {
        std::wcout << L"Option Display Name: " << option.getDisplayName() << std::endl;
        std::wcout << L"Option Description: " << option.getDescription() << std::endl;
        std::wcout << L"Option Default Value: " << option.getDefaultValue() << std::endl;
        std::wcout << L"Option Type: " << option.getType() << std::endl;
        std::wcout << L"Option Flags: " << option.getFlags() << std::endl;

        // Get possible values
        const std::vector<std::wstring>& possibleValues = option.getPossibleValues();
        std::wcout << L"Option Possible Values: ";
        for (const auto& value : possibleValues) {
            std::wcout << value << L", ";
        }
        std::wcout << std::endl;
    } 

    return 0;
}

See Also