CharacterBar Class |
Caution |
---|
Namespace: Kofax.OmniPageCSDK.ToolBoxes
The CharacterBar type exposes the following members.
Name | Description | |
---|---|---|
CharacterBar | Initializes a new instance of the CharacterBar class |
Name | Description | |
---|---|---|
Bar |
To set whether focus is given to a character if clicked.
| |
BarLineCount |
To set how many lines are occupied by the recent and full characterbars.
| |
CharacterSets |
To set what languages are displayed.
| |
Lock |
To set whether the CharacterBar is locked or not.
| |
RecentCharacters |
To display a character in the recent bar after it has been clicked.
| |
SupportedCharactersOnly |
To set whether only CSDK OCR supported character ranges are available or any other as well.
| |
Visibility |
To set whether to display the 3 states of the CharacterBar.
|
Name | Description | |
---|---|---|
Attach |
Use this method to attach the control to an existing document object. | |
Detach |
Use this method to detach the control from an existing document. | |
ExecuteCommand(Int32) |
Executes control specific command if enabled programatically.
| |
ExecuteCommand(CHARACTERBARCOMMAND) |
To force executing a CharacterBar command.
| |
GetBarSize |
To query how much horizontal and vertical space the CharacterBar requires.
| |
GetCommandState(Int32, Boolean, Boolean) |
Returns control specific command state as enabled or checked.
| |
GetCommandState(CHARACTERBARCOMMAND, Boolean, Boolean) |
To request information about a CharacterBar command.
| |
GetMenu |
Returns a full menu about its own commands.
| |
GetMenuString |
Returns control specific menu string to be displayed in a menu.
| |
GetMessageString |
Returns a detailed control specific menu string to be displayed in a menu.
| |
Int_Attach |
To attach the control to an existing IPRO object.
| |
Int_Detach |
To detach the control from an existing IPRO object.
| |
LineHeight |
To fill the available area with the characterbar map based on CHARACTERBARALIGNMENT/>.
| |
RefreshCharacters |
To refresh the character list.
| |
SetCommandHelpID |
Pairs a help ID to each command.
| |
SetHelpID |
If set, and F1 is pressed, returns a SetHelp ID from OnSetHelp | |
SetUILang |
Sets UI language from LANGUAGES enumeration of IPRO.
|
Name | Description | |
---|---|---|
OnAddRange |
Use this method to control the size of character ranges to be displayed.
| |
OnCharacter |
This event is fired when a character is selected in CharacterBar.
| |
OnEnterModal | ||
OnLeaveModal | ||
OnOfflineEnabledCharacters |
To set if a character is enabled or not.
| |
OnOfflineSupportedCharacters |
To set if a character is supported or not.
| |
OnRangeChanged |
To display the new character range state after it has been changed.
| |
OnRangeChanging |
To turn a character range on/off.
| |
OnSetHelp | ||
OnSetLineCount |
To set how many lines the characterbar occupies.
| |
OnSetMessageString | ||
OnSetToolTip |