Search settings More...

Inheritance diagram for TRIM.SDK.SearchUserOptions:

Public Member Functions
	SearchUserOptions (Database inDatabase)
	Constructor for the SearchUserOptions option set. More...

Public Member Functions inherited from TRIM.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 TRIM.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	ActivityDueSearchIncludesAuthorization `[get, set]`
	Activities Due search includes Activities requiring your authorization More...

bool	ActivityDueSearchIncludesEscalated `[get, set]`
	Activities Due search includes Activities escalated to you More...

bool	AlphaObjectSort `[get, set]`
	Use alphabetical order for object sorting More...

bool	AssigneeSearchIncludesDelegates `[get, set]`
	When searching by assignee, include delegates for current user More...

bool	AssigneeSearchIncludesGroups `[get, set]`
	When searching by assignee, include groups for current user More...

bool	AssigneeSearchIncludesPosition `[get, set]`
	When searching by assignee, include person's position More...

bool	AutomaticallyViewRecords `[get, set]`
	Automatically view electronic Records More...

bool	DefaultIncludesContent `[get, set]`
	When using a default record search, look for matches in Record document content More...

bool	DefaultIncludesNotes `[get, set]`
	When using a default record search, look for matches in Record notes More...

bool	DefaultIncludesNumber `[get, set]`
	When using a default record search, look for matching Record numbers More...

bool	DefaultIncludesTitle `[get, set]`
	When using a default record search, look for matches in Record titles More...

string	DefaultSortClassificationRecords `[get, set]`
	Default sort order when displaying records within a classification More...

string	DefaultSortClientMatters `[get, set]`
	Default sort order when displaying matter records for a client record More...

string	DefaultSortContainerContents `[get, set]`
	Default sort order when displaying records within a container More...

string	DefaultSortMatterRecords `[get, set]`
	Default sort order when displaying records associated with a matter record More...

SearchEditor	Editor `[get, set]`
	Default Search Editor More...

bool	IncludeAlternateWhenShowingFolderContents `[get, set]`
	Include 'Alternatively within' relationship when displaying the contents of a folder More...

bool	IncludeLocationsByAddressReference `[get, set]`
	When searching for Locations, include Locations that match because of a 'use address of' reference More...

bool	IncludeLocationsByProfileReference `[get, set]`
	When searching for Locations, include Locations that match because of a 'use profile of' reference More...

long	PreferredDistance `[get, set]`
	Preferred distance More...

GeographyDistanceUnit	PreferredGDU `[get, set]`
	Preferred distance unit More...

SearchEditor	RecordEditor `[get, set]`
	Default Search Editor for Record searches More...

ResultPostProcessingMethod	ResultPostProcessing `[get, set]`
	Post processing of search results More...

SearchStartPoint	StartPointDefault `[get, set]`
	Starting point when searching for anything other than Records or Locations More...

DesktopStartStates	StartPointForContainers `[get, set]`
	Starting point when searching for a container More...

DesktopStartStates	StartPointForDocuments `[get, set]`
	Starting point when searching for a document More...

SearchStartPoint	StartPointForLocations `[get, set]`
	Starting point when searching for Locations More...

DesktopStartStates	StartPointRecordDefault `[get, set]`
	Starting point when searching for a Record More...

bool	TempTableSecurityFiltering `[get, set]`
	Use a temporary table to do security filtering More...

bool	UnionForOrOptimization `[get, set]`
	Use UNION to optimize OR search operators More...

bool	UseSameWindowWhenNavigating `[get, set]`
	Use same search window when navigating More...

Properties inherited from TRIM.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 TRIM.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 settings

Constructor & Destructor Documentation

◆ SearchUserOptions()

TRIM.SDK.SearchUserOptions.SearchUserOptions ( Database inDatabase )

Constructor for the SearchUserOptions option set.

Member Function Documentation

◆ IsOptionRelevantFor()

static bool TRIM.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

◆ ActivityDueSearchIncludesAuthorization

bool TRIM.SDK.SearchUserOptions.ActivityDueSearchIncludesAuthorization

getset

Activities Due search includes Activities requiring your authorization

◆ ActivityDueSearchIncludesEscalated

bool TRIM.SDK.SearchUserOptions.ActivityDueSearchIncludesEscalated

getset

Activities Due search includes Activities escalated to you

◆ AlphaObjectSort

bool TRIM.SDK.SearchUserOptions.AlphaObjectSort

getset

Use alphabetical order for object sorting

◆ AssigneeSearchIncludesDelegates

bool TRIM.SDK.SearchUserOptions.AssigneeSearchIncludesDelegates

getset

When searching by assignee, include delegates for current user

◆ AssigneeSearchIncludesGroups

bool TRIM.SDK.SearchUserOptions.AssigneeSearchIncludesGroups

getset

When searching by assignee, include groups for current user

◆ AssigneeSearchIncludesPosition

bool TRIM.SDK.SearchUserOptions.AssigneeSearchIncludesPosition

getset

When searching by assignee, include person's position

◆ AutomaticallyViewRecords

bool TRIM.SDK.SearchUserOptions.AutomaticallyViewRecords

getset

Automatically view electronic Records

◆ DefaultIncludesContent

bool TRIM.SDK.SearchUserOptions.DefaultIncludesContent

getset

When using a default record search, look for matches in Record document content

◆ DefaultIncludesNotes

bool TRIM.SDK.SearchUserOptions.DefaultIncludesNotes

getset

When using a default record search, look for matches in Record notes

◆ DefaultIncludesNumber

bool TRIM.SDK.SearchUserOptions.DefaultIncludesNumber

getset

When using a default record search, look for matching Record numbers

◆ DefaultIncludesTitle

bool TRIM.SDK.SearchUserOptions.DefaultIncludesTitle

getset

When using a default record search, look for matches in Record titles

◆ DefaultSortClassificationRecords

string TRIM.SDK.SearchUserOptions.DefaultSortClassificationRecords

getset

Default sort order when displaying records within a classification

◆ DefaultSortClientMatters

string TRIM.SDK.SearchUserOptions.DefaultSortClientMatters

getset

Default sort order when displaying matter records for a client record

◆ DefaultSortContainerContents

string TRIM.SDK.SearchUserOptions.DefaultSortContainerContents

getset

Default sort order when displaying records within a container

◆ DefaultSortMatterRecords

string TRIM.SDK.SearchUserOptions.DefaultSortMatterRecords

getset

Default sort order when displaying records associated with a matter record

◆ Editor

SearchEditor TRIM.SDK.SearchUserOptions.Editor

getset

Default Search Editor

◆ IncludeAlternateWhenShowingFolderContents

bool TRIM.SDK.SearchUserOptions.IncludeAlternateWhenShowingFolderContents

getset

Include 'Alternatively within' relationship when displaying the contents of a folder

◆ IncludeLocationsByAddressReference

bool TRIM.SDK.SearchUserOptions.IncludeLocationsByAddressReference

getset

When searching for Locations, include Locations that match because of a 'use address of' reference

◆ IncludeLocationsByProfileReference

bool TRIM.SDK.SearchUserOptions.IncludeLocationsByProfileReference

getset

When searching for Locations, include Locations that match because of a 'use profile of' reference

◆ PreferredDistance

long TRIM.SDK.SearchUserOptions.PreferredDistance

getset

Preferred distance

◆ PreferredGDU

GeographyDistanceUnit TRIM.SDK.SearchUserOptions.PreferredGDU

getset

Preferred distance unit

◆ RecordEditor

SearchEditor TRIM.SDK.SearchUserOptions.RecordEditor

getset

Default Search Editor for Record searches

◆ ResultPostProcessing

ResultPostProcessingMethod TRIM.SDK.SearchUserOptions.ResultPostProcessing

getset

Post processing of search results

◆ StartPointDefault

SearchStartPoint TRIM.SDK.SearchUserOptions.StartPointDefault

getset

Starting point when searching for anything other than Records or Locations

◆ StartPointForContainers

DesktopStartStates TRIM.SDK.SearchUserOptions.StartPointForContainers

getset

Starting point when searching for a container

◆ StartPointForDocuments

DesktopStartStates TRIM.SDK.SearchUserOptions.StartPointForDocuments

getset

Starting point when searching for a document

◆ StartPointForLocations

SearchStartPoint TRIM.SDK.SearchUserOptions.StartPointForLocations

getset

Starting point when searching for Locations

◆ StartPointRecordDefault

DesktopStartStates TRIM.SDK.SearchUserOptions.StartPointRecordDefault

getset

Starting point when searching for a Record

◆ TempTableSecurityFiltering

bool TRIM.SDK.SearchUserOptions.TempTableSecurityFiltering

getset

Use a temporary table to do security filtering

◆ UnionForOrOptimization

bool TRIM.SDK.SearchUserOptions.UnionForOrOptimization

getset

Use UNION to optimize OR search operators

◆ UseSameWindowWhenNavigating

bool TRIM.SDK.SearchUserOptions.UseSameWindowWhenNavigating

getset

Use same search window when navigating

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SearchUserOptions()

Member Function Documentation

◆ IsOptionRelevantFor()

Property Documentation

◆ ActivityDueSearchIncludesAuthorization

◆ ActivityDueSearchIncludesEscalated

◆ AlphaObjectSort

◆ AssigneeSearchIncludesDelegates

◆ AssigneeSearchIncludesGroups

◆ AssigneeSearchIncludesPosition

◆ AutomaticallyViewRecords

◆ DefaultIncludesContent

◆ DefaultIncludesNotes

◆ DefaultIncludesNumber

◆ DefaultIncludesTitle

◆ DefaultSortClassificationRecords

◆ DefaultSortClientMatters

◆ DefaultSortContainerContents

◆ DefaultSortMatterRecords

◆ Editor

◆ IncludeAlternateWhenShowingFolderContents

◆ IncludeLocationsByAddressReference

◆ IncludeLocationsByProfileReference

◆ PreferredDistance

◆ PreferredGDU

◆ RecordEditor

◆ ResultPostProcessing

◆ StartPointDefault

◆ StartPointForContainers

◆ StartPointForDocuments

◆ StartPointForLocations

◆ StartPointRecordDefault

◆ TempTableSecurityFiltering

◆ UnionForOrOptimization

◆ UseSameWindowWhenNavigating