Micro Focus Content Manager SDK 9.3
HP.HPTRIM.SDK.SpellingUserOptions Class Reference

Spelling|Spelling checker dictionaries (SpellingUserOptions) More...

Inheritance diagram for HP.HPTRIM.SDK.SpellingUserOptions:
HP.HPTRIM.SDK.TrimUserOptionSet HP.HPTRIM.SDK.TrimPropertySet

Public Member Functions

 SpellingUserOptions (Database inDatabase)
 Constructor for the SpellingUserOptions option set. More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimUserOptionSet
 TrimUserOptionSet (Database db, UserOptionSetIds setId)
 Base constructor, constructs a TRIM user option set of the specified option set type. More...
 
void Save ()
 Permanently commits all changes made to this option set. More...
 
void LoadFromGlobalSetting ()
 Load the administrators "global settings" for this option set More...
 
void SaveAsGlobalSetting ()
 Save this set as the "global setting" for this option set More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimPropertySet
TrimIcon GetPropertyIcon (PropertyIds propertyId)
 Gets the icon value associated the a property of this object. More...
 
TrimMainObject GetPropertyTrimObject (PropertyIds dnPropId)
 
string GetPropertyString (PropertyIds dnPropId)
 
int GetPropertyLong (PropertyIds dnPropId)
 
long GetPropertyLong64 (PropertyIds dnPropId)
 
bool GetPropertyBool (PropertyIds dnPropId)
 
TrimDateTime GetPropertyDate (PropertyIds dnPropId)
 
TrimDecimal GetPropertyDecimal (PropertyIds dnPropId)
 
TrimCurrency GetPropertyCurrency (PropertyIds dnPropId)
 
TrimURI GetPropertyUri (PropertyIds dnPropId)
 
bool SetPropertyTrimObject (PropertyIds dnPropId, TrimMainObject newValue)
 
bool SetPropertyString (PropertyIds dnPropId, string newValue)
 
bool SetPropertyLong (PropertyIds dnPropId, int newValue)
 
bool SetPropertyLong64 (PropertyIds dnPropId, long newValue)
 
bool SetPropertyBool (PropertyIds dnPropId, bool newValue)
 
bool SetPropertyDate (PropertyIds dnPropId, TrimDateTime newValue)
 
bool SetPropertyCurrency (PropertyIds dnPropId, TrimCurrency newValue)
 
bool SetPropertyDecimal (PropertyIds dnPropId, TrimDecimal newValue)
 
bool SetPropertyDouble (PropertyIds dnPropId, double newValue)
 
bool SetPropertyUri (PropertyIds dnPropId, TrimURI newValue)
 
bool ClearProperty (PropertyIds dnPropId)
 
object GetProperty (PropertyIds propId)
 
bool SetProperty (PropertyIds propId, object newValue)
 
string GetPropertyAsString (PropertyIds propertyId, StringDisplayType propertyValueStringType, bool useHTMLEscapeChars)
 Gets a string representation of a property value in a format appropriate for a specific use. More...
 
bool IsMandatory (PropertyIds propertyId)
 Gets a boolean value indication whether the specified property must have a non-NULL value for this object. More...
 
bool VerifyProperty (PropertyIds propertyId, bool doMandatoryChecks)
 Verifies the value of a particular property, by cross checking it against other property values. The ErrorMessage property provides details if the verification fails. More...
 
bool CanModifyProperty (PropertyIds propertyId)
 Indicates whether the current user has the permission to modify the specified property. More...
 

Properties

string AdvancedSpellingOptions [get, set]
 
string ExtraDictionaries [get, set]
 
bool UseAmerican [get, set]
 
bool UseBritish [get, set]
 
bool UseChinese [get, set]
 
bool UseDutch [get, set]
 
bool UseFrench [get, set]
 
bool UseGerman [get, set]
 
bool UseItalian [get, set]
 
bool UsePortuguese [get, set]
 
bool UsePortugueseBrazil [get, set]
 
bool UseRussian [get, set]
 
bool UseSpanish [get, set]
 
bool UseSwedish [get, set]
 
bool UseVietnamese [get, set]
 
- Properties inherited from HP.HPTRIM.SDK.TrimUserOptionSet
UserOptionSetIds OptionSetType [get]
 
bool IsReadOnly [get]
 Gets a BaseObjectTypes enum value indicating the type of this object. Gets a boolean parameter indicating if this option set has been locked down and is therefore unable to be modified. More...
 
- Properties inherited from HP.HPTRIM.SDK.TrimPropertySet
string ErrorMessage [get]
 All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...
 
TrimException Error [get]
 All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...
 
Database Database [get]
 Gets the TRIM Database object in which this object resides. All TRIM objects live within a particular TRIM database and cannot be created without one. More...
 
virtual string Caption [get]
 Gets the user-defined caption that has been associated with all TrimPropertySets of this type. More...
 
virtual TrimIcon Icon [get]
 Gets the icon value associated this TrimPropertySet. More...
 
bool IsModified [get]
 Gets a boolean parameter indicating if any changes have been made to this object since it was first constructed, or last saved. More...
 

Detailed Description

Spelling|Spelling checker dictionaries (SpellingUserOptions)

Constructor & Destructor Documentation

HP.HPTRIM.SDK.SpellingUserOptions.SpellingUserOptions ( Database  inDatabase)

Constructor for the SpellingUserOptions option set.

Property Documentation

string HP.HPTRIM.SDK.SpellingUserOptions.AdvancedSpellingOptions
getset
string HP.HPTRIM.SDK.SpellingUserOptions.ExtraDictionaries
getset
bool HP.HPTRIM.SDK.SpellingUserOptions.UseAmerican
getset
bool HP.HPTRIM.SDK.SpellingUserOptions.UseBritish
getset
bool HP.HPTRIM.SDK.SpellingUserOptions.UseChinese
getset
bool HP.HPTRIM.SDK.SpellingUserOptions.UseDutch
getset
bool HP.HPTRIM.SDK.SpellingUserOptions.UseFrench
getset
bool HP.HPTRIM.SDK.SpellingUserOptions.UseGerman
getset
bool HP.HPTRIM.SDK.SpellingUserOptions.UseItalian
getset
bool HP.HPTRIM.SDK.SpellingUserOptions.UsePortuguese
getset
bool HP.HPTRIM.SDK.SpellingUserOptions.UsePortugueseBrazil
getset
bool HP.HPTRIM.SDK.SpellingUserOptions.UseRussian
getset
bool HP.HPTRIM.SDK.SpellingUserOptions.UseSpanish
getset
bool HP.HPTRIM.SDK.SpellingUserOptions.UseSwedish
getset
bool HP.HPTRIM.SDK.SpellingUserOptions.UseVietnamese
getset