EnumIsFlags Property

Summary

Gets a value indicating whether the enum members can be OR'ed together.

Syntax

Objective-C

C++

Java

public bool EnumIsFlags { get; }

ReadOnly Property EnumIsFlags As Boolean

@property (nonatomic, assign, readonly) BOOL enumIsFlags

public boolean getEnumIsFlags()

property bool EnumIsFlags { 
   bool get(); 
}

Property Value

True if the enum members can be OR'ed {|}together (the enum has a flag type); otherwise it is false.

Remarks

If the enum members can be OR'ed{|} together, you can OR{|} multiple members obtained from GetEnumMemberValues or GetEnumMemberFriendlyNames into one integer or string value (separated by a comma) and pass them as the setting value. This is the same as having an enum in .NET decorated with the FlagsAttribute.

If the enum members cannot be OR'ed together (The value of EnumIsFlags is false), then only one member from obtained from GetEnumMemberValues or GetEnumMemberFriendlyNames can used as the setting value. This the same as having an enum in .NET not decorated with the FlagsAttribute.

This member is only valid if ValueType is OcrSettingValueType.Enum.

For a list of supported engine-specific settings and their meanings, refer to OCR engine-specific Settings.

Example

For an example, refer to IOcrSettingManager.

Requirements

Target Platforms