Document.GetUserDictionary Method
|
This method returns the name and section information for the currently selected user dictionary.
Namespace:
Kofax.OmniPageCSDK.IproPlus
Assembly:
Kofax.OmniPageCSDK.IproPlus (in Kofax.OmniPageCSDK.IproPlus.dll) Version: 1.0.0.0
Syntaxpublic void GetUserDictionary(
out string Name,
out bool Embedded,
[OptionalAttribute] out Object SectionName
)
Public Sub GetUserDictionary (
<OutAttribute> ByRef Name As String,
<OutAttribute> ByRef Embedded As Boolean,
<OptionalAttribute> <OutAttribute> ByRef SectionName As Object
)
public:
void GetUserDictionary(
[OutAttribute] String^% Name,
[OutAttribute] bool% Embedded,
[OptionalAttribute] [OutAttribute] Object^% SectionName
)
Parameters
- Name
- Type: System.String
- Embedded
- Type: System.Boolean
- SectionName (Optional)
- Type: System.Object
Remarks
If the user dictionary is embedded in the document, the Embedded parameter
is set to True and the name of the related custom data stream of type CD_USERDICT is returned. Otherwise, the fully qualified path of the user dictionary file is returned.
If there is no user dictionary set for this document, the Name and Section parameters are empty strings and the Embedded parameter is false.
See Also