ImageViewGetCommandState Method (IVCTOOLBARBUTTON, Boolean, Boolean)
|
Use this method to request information about a particular toolbar command.
Namespace:
Kofax.OmniPageCSDK.ToolBoxes
Assembly:
Kofax.OmniPageCSDK.ToolBoxes (in Kofax.OmniPageCSDK.ToolBoxes.dll) Version: 1.0.0.0
Syntaxpublic void GetCommandState(
IVCTOOLBARBUTTON Command,
ref bool Checked,
ref bool Enabled
)
Public Sub GetCommandState (
Command As IVCTOOLBARBUTTON,
ByRef Checked As Boolean,
ByRef Enabled As Boolean
)
public:
void GetCommandState(
IVCTOOLBARBUTTON Command,
bool% Checked,
bool% Enabled
)
Parameters
- Command
- Type: Kofax.OmniPageCSDK.ToolBoxesIVCTOOLBARBUTTON
- Checked
- Type: SystemBoolean
- Enabled
- Type: SystemBoolean
Remarks
The CommandID parameter holds an
IVCTOOLBARBUTTON enumeration value.
The Enabled parameter returns whether the command identified by CommandID is currently enabled or not. If the related toolbar button is an type
on / off type (e.g. IVC_RECMODULE_OMNIFONT_* commands), you can use the Checked parameter to query its current state. This function is useful if
your application implements its own menu or toolbar which requires control state refreshing. You can also use this method to verify if a particular
command can be executed using the ExecuteCommand method or not.
See Also