Search|Search settings (SearchUserOptions) More...

Inheritance diagram for HP.HPTRIM.SDK.SearchUserOptions:

Public Member Functions
	SearchUserOptions (Database inDatabase)
	Constructor for the SearchUserOptions 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...

Static Public Member Functions
static bool	IsOptionRelevantFor (PropertyIds searchPropertyId, BaseObjectTypes searchForType)
	determines if the specified search option is relevant for using with searches for the nominated object type More...

Properties
bool	AlphaObjectSort `[get, set]`

bool	AnyWordContents `[get, set]`

bool	AnyWordNotes `[get, set]`

bool	AnyWordTitle `[get, set]`

bool	AssigneeSearchIncludesAuthorisation `[get, set]`

bool	AssigneeSearchIncludesDelegates `[get, set]`

bool	AssigneeSearchIncludesEscalated `[get, set]`

bool	AssigneeSearchIncludesGroups `[get, set]`

bool	AssigneeSearchIncludesPosition `[get, set]`

bool	AutomaticallyViewRecords `[get, set]`

bool	ContentsInReverseDateOrder `[get, set]`

bool	DefaultIncludesContent `[get, set]`

bool	DefaultIncludesNotes `[get, set]`

bool	DefaultIncludesNumber `[get, set]`

bool	DefaultIncludesTitle `[get, set]`

SearchEditor	Editor `[get, set]`

bool	ExtendedIDOLOptimization `[get, set]`

IdolSearchStyles	IdolSearchStyle `[get, set]`

bool	IncludeAlternateWhenShowingFolderContents `[get, set]`

bool	IncludeLocationsByAddressReference `[get, set]`

bool	IncludeLocationsByProfileReference `[get, set]`

long	PreferredDistance `[get, set]`

GeographyDistanceUnit	PreferredGDU `[get, set]`

SearchEditor	RecordEditor `[get, set]`

SearchStartPoint	StartPointDefault `[get, set]`

DesktopStartStates	StartPointForContainers `[get, set]`

DesktopStartStates	StartPointForDocuments `[get, set]`

SearchStartPoint	StartPointForLocations `[get, set]`

DesktopStartStates	StartPointRecordDefault `[get, set]`

bool	TempTableSecurityFiltering `[get, set]`

bool	UnionForOrOptimization `[get, set]`

bool	UseDirectIDOLquery `[get, set]`

bool	UseSameWindowWhenNavigating `[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

Search|Search settings (SearchUserOptions)

Constructor & Destructor Documentation

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

Constructor for the SearchUserOptions option set.

Member Function Documentation

static bool HP.HPTRIM.SDK.SearchUserOptions.IsOptionRelevantFor	(	PropertyIds	searchPropertyId,
		BaseObjectTypes	searchForType
	)

static

determines if the specified search option is relevant for using with searches for the nominated object type

Property Documentation

bool HP.HPTRIM.SDK.SearchUserOptions.AlphaObjectSort

getset

bool HP.HPTRIM.SDK.SearchUserOptions.AnyWordContents

getset

bool HP.HPTRIM.SDK.SearchUserOptions.AnyWordNotes

getset

bool HP.HPTRIM.SDK.SearchUserOptions.AnyWordTitle

getset

bool HP.HPTRIM.SDK.SearchUserOptions.AssigneeSearchIncludesAuthorisation

getset

bool HP.HPTRIM.SDK.SearchUserOptions.AssigneeSearchIncludesDelegates

getset

bool HP.HPTRIM.SDK.SearchUserOptions.AssigneeSearchIncludesEscalated

getset

bool HP.HPTRIM.SDK.SearchUserOptions.AssigneeSearchIncludesGroups

getset

bool HP.HPTRIM.SDK.SearchUserOptions.AssigneeSearchIncludesPosition

getset

bool HP.HPTRIM.SDK.SearchUserOptions.AutomaticallyViewRecords

getset

bool HP.HPTRIM.SDK.SearchUserOptions.ContentsInReverseDateOrder

getset

bool HP.HPTRIM.SDK.SearchUserOptions.DefaultIncludesContent

getset

bool HP.HPTRIM.SDK.SearchUserOptions.DefaultIncludesNotes

getset

bool HP.HPTRIM.SDK.SearchUserOptions.DefaultIncludesNumber

getset

bool HP.HPTRIM.SDK.SearchUserOptions.DefaultIncludesTitle

getset

SearchEditor HP.HPTRIM.SDK.SearchUserOptions.Editor

getset

bool HP.HPTRIM.SDK.SearchUserOptions.ExtendedIDOLOptimization

getset

IdolSearchStyles HP.HPTRIM.SDK.SearchUserOptions.IdolSearchStyle

getset

bool HP.HPTRIM.SDK.SearchUserOptions.IncludeAlternateWhenShowingFolderContents

getset

bool HP.HPTRIM.SDK.SearchUserOptions.IncludeLocationsByAddressReference

getset

bool HP.HPTRIM.SDK.SearchUserOptions.IncludeLocationsByProfileReference

getset

long HP.HPTRIM.SDK.SearchUserOptions.PreferredDistance

getset

GeographyDistanceUnit HP.HPTRIM.SDK.SearchUserOptions.PreferredGDU

getset

SearchEditor HP.HPTRIM.SDK.SearchUserOptions.RecordEditor

getset

SearchStartPoint HP.HPTRIM.SDK.SearchUserOptions.StartPointDefault

getset

DesktopStartStates HP.HPTRIM.SDK.SearchUserOptions.StartPointForContainers

getset

DesktopStartStates HP.HPTRIM.SDK.SearchUserOptions.StartPointForDocuments

getset

SearchStartPoint HP.HPTRIM.SDK.SearchUserOptions.StartPointForLocations

getset

DesktopStartStates HP.HPTRIM.SDK.SearchUserOptions.StartPointRecordDefault

getset

bool HP.HPTRIM.SDK.SearchUserOptions.TempTableSecurityFiltering

getset

bool HP.HPTRIM.SDK.SearchUserOptions.UnionForOrOptimization

getset

bool HP.HPTRIM.SDK.SearchUserOptions.UseDirectIDOLquery

getset

bool HP.HPTRIM.SDK.SearchUserOptions.UseSameWindowWhenNavigating

getset

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation