Defines characteristics of a user-defined metadata element that can be used to supplement standard Content Manager data elements for some objects More...

Inheritance diagram for TRIM.SDK.FieldDefinition:

Public Member Functions
	FieldDefinition (Database database, TrimURI uri)

	FieldDefinition (Database database, string name)

	FieldDefinition (Database database)

bool	IsUsedFor (TrimObject objectToTest)
	Returns a Boolean value indicating whether this user defined field is used for the nominated TrimObject. More...

bool	IsUsedForAny (BaseObjectTypes objectTypeToTest)
	Returns a Boolean value indicating whether this user defined field is used for the objects (or any subcategory of objects) of the nominated TRIM object type. More...

void	SetIsUsedFor (TrimObject objectToTest, bool turnUsageOn)
	Adds or removes this user field from the list of user fields for the nominated Base Object (and hence all other objects of the same type category). For example, if the nominated base object is an organization, then this method will set this user field's usage for all organization Locations. More...

void	SetIsUsedFor (BaseObjectTypes objectType, bool turnUsageOn)
	Adds or removes this user field from the list of user fields for the nominated Base Object Type. You cannot use this form to turn usage on for records or Locations, since these object types have a further condition that is used to determine if a field is applicable. More...

void	SetIsUsedForRecord (RecordType recordTypeForUsage, bool turnUsageOn)
	Adds or removes this user field from the list of user fields for the nominated Record Type. More...

void	SetIsUsedForLocation (LocationType locationTypeForUsage, bool turnUsageOn)
	Adds or removes this user field from the list of user fields for the nominated Location Type. More...

void	SetIsUsedForWorkflow (WorkflowTemplate templateForUsage, bool turnUsageOn)
	Adds or removes this user field from the list of user fields for the nominated Workflow Template More...

void	SetIsUsedForWorkflowWithNoTemplate (bool turnUsageOn)
	Adds or removes this user field from the list of user fields available for any workflow that is not based on a template More...

bool	IsMandatory (TrimObject forObject)
	Gets a boolean value indicating if the property or field is mandatory (cannot have an empty/null value) for the supplied TRIM object. More...

void	SetValidLocationType (LocationType locType, bool includeThisType)
	Sets which type of location is valid for this user field (if it is a field of type 'Object (Location)' More...

bool	IsLocationTypeValid (LocationType locType)
	Gets a boolean value indicating if this field definition will accept a location of the specified type. More...

FieldDefinition	NewCopy ()

bool	CanSearch (BaseObjectTypes whenSearchingForObjectType, bool excludeBlockedSearchMethods)
	Gets a Boolean value indicating if this field definition can be used for a search for items of the specified type. More...

bool	CanSort (BaseObjectTypes whenSearchingForObjectType)
	Gets a Boolean value indicating if this field definition can be used for sorting a search for items of the specified type. More...

void	SetNotes (string newValue, NotesUpdateType TypeOfNotesUpdate)
	Updates the notes attached to this object. Typically used when a new contibution is to be combined with the existing notes, as some users only have the privilige to add to the notes, rather than overwriting them. More...

Public Member Functions inherited from TRIM.SDK.TrimMainObject
virtual void	Save ()
	Permanently commits all changes made to this object (and all its child objects). For new objects a new unique identifier will be allocated (Uri). More...

string	MakeReference (string SuggestName)
	Creates a TRIM reference file for this object, given the path and filename. A reference file can be associated with the Open command of various of the TRIM executables - TRIM.exe, TRIMDesktop.exe, etc. When the reference file is double-clicked, the associated application will then launch (or activate if it already running) and the object will then be displayed inside that executable. Returns a string containing the path and filename of the reference file created. More...

virtual void	Delete ()
	Permanently removes this object and all its associated child objects from the database. More...

bool	IsDeleteOk ()
	Determines if this object can be deleted. If it returns false, check the ErrorMessage details for more information. It is possible that the ErrorMessage property could contain a warning message even though the function returns true. More...

bool	Verify (bool failOnWarning)
	Verifies all properties that have been modified since this object was last saved. Returns a Boolean value indicating whether the function succeeded. If false, the error description is stored in the ErrorMessage property. More...

TrimChildObjectList	GetChildObjectList (BaseObjectTypes childType)
	Retrieves the child object collection of the nominated child object type. More...

TrimMainObject	GetNewCopy ()
	Creates a new TrimMainObject which is a copy of this TrimMainObject. Where appropriate, property values are copied from this TrimMainObject to the new TrimMainObject. You will generally need to set any unique properties manually afterwards, prior to committing this new TrimMainObject to the TRIM database with the Save() method. See also the NewCopy function of the derived objects that implement this capability. Will return NULL if this object does not support the Copy function. More...

virtual void	Refresh ()
	Resets this object to the current state on the database, will revert any changes that might have been made. Only required if you are not using BOBnotifications, or need to guarantee a really up-to-date version of the object state. More...

virtual void	Reindex (bool doWordIndex, bool doAdditionalFields, bool doContentEngine)
	Sends an indexing request to the event processor to update main text index on the object, indexes for additional fields or indexes for the content engine. More...

Public Member Functions inherited from TRIM.SDK.TrimObject
bool	IsMandatory (FieldDefinition field)
	Gets a boolean value indication whether the specified field must have a non-NULL value for this object. More...

bool	IsValidFor (int purpose)
	Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. More...

bool	IsValidFor (int purpose, TrimMainObject purposeExtraObject)
	Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraObject is necessary for some purpose types - once again, the derived class will have more information. More...

bool	IsValidFor (int purpose, int purposeExtraEnumValue)
	Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraInformation is necessary for some purpose types - once again, the derived class will have more information. More...

bool	HasPermission (GenericPermissions prm)
	Checks to see if the currently logged in user has permission to perform the generic action on this object More...

bool	HasPropertyPermission (GenericPermissions prm, PropertyIds propId)
	Checks to see if the currently logged in user has permission to perform the generic action on the specified property of this object 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 FieldDefinition	FindFieldBySearchClauseName (Database inDatabase, BaseObjectTypes objectToLookFor, string clauseName)
	A static method used to find a field definition that has a search clause name corresponding to the supplied string. More...

Properties
string	Abbreviation `[get, set]`
	Gets or sets a string containing an abbreviation for the user field corresponding to this FieldDefinition object. More...

bool	AllowNegative `[get, set]`
	Gets or sets a Boolean property indicating whether numeric values are allowed to be negative (number, big number, currency and decimal formats only). More...

bool	AllowUpdateForDestroyed `[get, set]`
	Gets or sets a Boolean property indicating whether the value of this field can be modified on a record that has been destroyed. More...

string	CurrencySymbol `[get, set]`
	Gets or sets a string containing the currency symbol to be used for fields of type currency. Leave blank to use the default currency symbol of the dataset. More...

bool	DateTimeIsUTC `[get, set]`
	Gets or sets a boolean value indicating whether date time values should be entered, displayed and searched as if they are UTC values rather than local time. More...

int	DecimalPlaces `[get, set]`
	Gets or sets a number corresponding to the number of decimal places to display when displaying this field (currency and decimal formats only, between 0 and 8). More...

bool	DefaultBoolean `[get]`
	Gets the default boolean value for this user field, if it is a boolean user field. This FieldDefinition object is a boolean user field if the property FieldDefinition.Format has the value 'ufBoolean'. More...

TrimCurrency	DefaultCurrency `[get]`
	Gets the default currency value for this user field, if it is a currency user field. This FieldDefinition object is a currency user field if the property FieldDefinition.Format has the value 'ufCurrency'. More...

TrimDateTime	DefaultDate `[get]`
	Gets the default date or datetime value for this user field, if it is a date or datetime user field. This FieldDefinition object is an date user field if the property FieldDefinition.Format has the value 'ufDate', and a datetime user field if FieldDefinition.Format has the value 'ufDateTime'. More...

TrimDecimal	DefaultDecimal `[get]`
	Gets the default decimal value for this user field, if it is a decimal user field. This FieldDefinition object is a decimal user field if the property FieldDefinition.Format has the value 'ufDecimal'. More...

string	DefaultDisplay `[get]`
	Gets a string representation of the default value of the user field corresponding to this FieldDefinition object in a format that is suitable for display purposes, e.g. with leading zeroes cut off. More...

string	DefaultInternal `[get]`
	Gets a string representation of the default value of the user field corresponding to this FieldDefinition object in the same format as it is stored in the database. More...

int	DefaultNumber `[get]`
	Gets the default integer value for this user field, if it is an integer user field. This FieldDefinition object is an integer user field if the property FieldDefinition.Format has the value 'ufNumber'. More...

string	DefaultString `[get]`
	Gets the default string value for this user field, if it is a string or text user field. This FieldDefinition object is a string user field if the property FieldDefinition.Format has the value 'ufString', and a text user field if FieldDefinition.Format has the value 'ufText'. More...

string	ExternalId `[get, set]`
	Gets or sets a string containing the External Identification Number for the user field corresponding to this FieldDefinition object. This identifier cannot be changed through the Content Manager user interface and so guarantees your program a reliable handle to the user field aside from the URI. More...

bool	ForceSpellCheck `[get, set]`
	Gets or sets a boolean value indicating that when entering a value for this field, the spelling check function should be mandatory. Only applies to fields of format string using the simple verification type or fields of format text. More...

UserFieldFormats	Format `[get, set]`
	Gets or sets a ufUserFieldFormats enum value indicating the format of the user field corresponding to this FieldDefinition object. The user field may be used to store boolean, currency, date, date and time, decimal, Content Manager object (currently restricted to Content Manager location), string or text values. More...

Icons	IconId `[get, set]`
	Gets or sets an Icons enumeration value to associate a standard Content Manager icon with this user field. More...

bool	InIDOLSchema `[get, set]`
	Gets or sets a boolean property indicating if this field should be included in the IDOL metadata schema when indexing records within IDOL. More...

bool	InIDOLtext `[get, set]`
	Gets or sets a boolean value indicating whether this user-defined field has been configured to include the value in the IDOL text indexing group. More...

string	IsUsedBy `[get]`
	Gets a string listing the objects using this user field in Content Manager. Does not include record types. More...

string	IsUsedByRecordTypes `[get]`
	Gets a string listing the record types using this user field in Content Manager. More...

bool	IsVisible `[get, set]`
	Gets the visible state of this field for the current user. More...

int	Length `[get, set]`
	Gets or sets an integer containing the maximum number of characters allowed in this user field, if it is a string user field. The value of this property may not exceed 255 characters. More...

Location?	LocationMustBeMemberOf `[get, set]`
	Gets or sets a location object that this field must be a member of. Only applies to fields of format object and type location. More...

LocationFieldType	LocationRestriction `[get, set]`
	Gets or sets a Location Field Type enumeration value indicating, for a field of format 'object (location)', whether internal or external locations are suitable More...

LookupSet?	LookupSet `[get, set]`
	Gets or sets a LookupSet object used to contain a set of acceptable string values for this user field, if it is a string or text user field. More...

string	LowerLimit `[get, set]`
	Gets or sets a string containing the lower limit, or minimum value of this user field. More...

string	Mask `[get, set]`
	Gets or sets a string containing an edit mask to be used for this user field, if this is a string user field. The mask is a combination of normal characters with the special characters 'N,A,X,Z,\'used to restrict the format of any string entered for this field. See the Content Manager Help File for more information on the edit mask format. More...

new string	Name `[get, set]`
	Gets or sets a string containing the name of the user field corresponding to this FieldDefinition object. More...

BaseObjectTypes	ObjectType `[get, set]`
	Gets or sets a BaseObjectTypes enum value indicating the Content Manager object type of the user field, if it is an object user field. More...

bool	OnlyLookupItemsInText `[get, set]`
	Gets or sets a boolean value indicating that when using a lookup set, the text can only contain lookup items and no additional text. Only applies to fields of format text. More...

bool	PluginBrowseOnly `[get, set]`
	Gets or sets a boolean value indicating that when entering a value for this field, the value cannot be typed bust must be selected using the KwikSelect key. Only applies to fields of format string using the addIn string verification type. More...

string	PluginId `[get, set]`
	Gets or sets a string containing the PROGID of an COM component implementing the validation function, if this is a string user field using a COM component for validation. More...

RecordType?	RecordMustBeOfType `[get, set]`
	Gets or sets a record type object that this field must have. Only applies to fields of format object and type record. More...

string	SapKeySetField `[get, set]`
	Gets or sets a string value that maps this user defined field to one of the fields in the SAP Keys extended metadata interface provided by the ArchiveLink Content Server. More...

string	SearchClause `[get, set]`
	Gets a string representing a user-specified clause name for this user field. More...

string	SearchClauseCaption `[get]`
	Gets a string representing a user-friendly version of the the search clause name used for this user field. More...

string	SearchClauseName `[get]`
	Gets a string representing the string to use when composing a search involving this user field. More...

StringVerificationTypes	StringVerificationType `[get, set]`
	Gets or sets a stringVerificationTypes enumerated value indicating how to validate the value of this field. Only applies to fields of format string. More...

string	SubstitutionString `[get]`
	Gets a string value which can be used as a substitution string when encoding this field into a text expression, such as an external link paramater. More...

string	UpperLimit `[get, set]`
	Gets or sets a string containing the upper limit, or maximum value of this user field. More...

UserFieldValue?	DefaultValue `[get, set]`
	Gets or sets the default value for the user defined field corresponding to this FieldDefinition object. More...

bool	CanModifyExistingNotes `[get]`

bool	CanAddToNotes `[get]`

string	Notes `[get, set]`

TrimAccessControlList?	AccessControlList `[get, set]`

TrimIcon	CustomIcon `[get, set]`

Icons	CustomIconInternal `[get]`

ExternalIcon?	CustomIconExternal `[get]`

Properties inherited from TRIM.SDK.TrimMainObject
TrimDateTime	LastUpdatedOn `[get]`
	Returns the date and time that changes to this object were last committed. More...

Location?	LastUpdatedBy `[get]`
	Returns the user that committed the most recent change to this object. More...

string	Name `[get]`
	Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...

bool	Verified `[get]`
	Gets a Boolean value indicating whether the object has been verified. That is, whether a call to the 'Verify' method has been made and has succeeded. More...

string	WebURL `[get]`

bool	IsInFavorites `[get]`
	Gets a boolean value indicating whether this object is in the current user's list of favorites More...

string	UpdateComment `[get, set]`
	Gets or sets a string value to be recorded with any audit entries related to the update of this object More...

Properties inherited from TRIM.SDK.TrimObject
BaseObjectTypes	TrimType `[get]`
	Gets a BaseObjectTypes enum value indicating the type of this object. More...

TrimURI	Uri `[get]`
	Gets the unique row identifier for this object. Once an object has been committed to the database, typically by calling a Save method, this unique identifier is allocated. From that time on, the uri will remain constant and can never be changed. It is always unique across all objects of the same Type. More...

string	URN `[get]`
	Gets the uniform resource name for this object. More...

string	NameString `[get]`
	Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...

string	NameStringExtra `[get]`
	Gets a more verbose description of this object, particularly when the name is perhaps a little cryptic or not enough to fully describe the object. More...

bool	IsReadOnly `[get]`
	Gets a boolean parameter indicating if this object is "ReadOnly". This would generally indicate that none of the object's properties could be modified, in some cases there are exceptions that can be tested via CanModifyProperty method. More...

bool	PossiblyHasSubordinates `[get]`
	Indicates if this object could possibly have child objects of the same type that can be displayed in a hierarchy. 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...

Properties inherited from TRIM.SDK.ITrimNotes
bool	CanModifyExistingNotes `[get]`
	Gets a boolean parameter indicating whether the current user can modify the existing notes attached to this object. More...

bool	CanAddToNotes `[get]`
	Gets a boolean value indicating whether the current user can either append or prepend some text to the existing notes. More...

string	Notes `[get, set]`
	Gets or sets a string value corresponding to the notes attached to this object. More...

Properties inherited from TRIM.SDK.ITrimAccessControl
TrimAccessControlList	AccessControlList `[get, set]`
	Gets or sets the access control list attached to this object. More...

Properties inherited from TRIM.SDK.ITrimCustomIcon
TrimIcon	CustomIcon `[get, set]`
	Gets or sets the custom icon associated with this object. More...

Icons	CustomIconInternal `[get]`
	Gets the internal icon identifier if the custom icon is based on an internal icon. More...

ExternalIcon	CustomIconExternal `[get]`
	Gets the external icon object if the custom icon associated with this object is an externally defined icon. More...

Detailed Description

Defines characteristics of a user-defined metadata element that can be used to supplement standard Content Manager data elements for some objects

Constructor & Destructor Documentation

◆ FieldDefinition() [1/3]

TRIM.SDK.FieldDefinition.FieldDefinition	(	Database	database,
		TrimURI	uri
	)

◆ FieldDefinition() [2/3]

TRIM.SDK.FieldDefinition.FieldDefinition	(	Database	database,
		string	name
	)

◆ FieldDefinition() [3/3]

TRIM.SDK.FieldDefinition.FieldDefinition ( Database database )

Member Function Documentation

◆ CanSearch()

bool TRIM.SDK.FieldDefinition.CanSearch	(	BaseObjectTypes	whenSearchingForObjectType,
		bool	excludeBlockedSearchMethods
	)

Gets a Boolean value indicating if this field definition can be used for a search for items of the specified type.

◆ CanSort()

bool TRIM.SDK.FieldDefinition.CanSort ( BaseObjectTypes whenSearchingForObjectType )

Gets a Boolean value indicating if this field definition can be used for sorting a search for items of the specified type.

◆ FindFieldBySearchClauseName()

static FieldDefinition TRIM.SDK.FieldDefinition.FindFieldBySearchClauseName	(	Database	inDatabase,
		BaseObjectTypes	objectToLookFor,
		string	clauseName
	)

static

A static method used to find a field definition that has a search clause name corresponding to the supplied string.

◆ IsLocationTypeValid()

bool TRIM.SDK.FieldDefinition.IsLocationTypeValid ( LocationType locType )

Gets a boolean value indicating if this field definition will accept a location of the specified type.

◆ IsMandatory()

bool TRIM.SDK.FieldDefinition.IsMandatory ( TrimObject forObject )

Gets a boolean value indicating if the property or field is mandatory (cannot have an empty/null value) for the supplied TRIM object.

◆ IsUsedFor()

bool TRIM.SDK.FieldDefinition.IsUsedFor ( TrimObject objectToTest )

Returns a Boolean value indicating whether this user defined field is used for the nominated TrimObject.

◆ IsUsedForAny()

bool TRIM.SDK.FieldDefinition.IsUsedForAny ( BaseObjectTypes objectTypeToTest )

Returns a Boolean value indicating whether this user defined field is used for the objects (or any subcategory of objects) of the nominated TRIM object type.

◆ NewCopy()

FieldDefinition TRIM.SDK.FieldDefinition.NewCopy ( )

◆ SetIsUsedFor() [1/2]

void TRIM.SDK.FieldDefinition.SetIsUsedFor	(	BaseObjectTypes	objectType,
		bool	turnUsageOn
	)

Adds or removes this user field from the list of user fields for the nominated Base Object Type. You cannot use this form to turn usage on for records or Locations, since these object types have a further condition that is used to determine if a field is applicable.

◆ SetIsUsedFor() [2/2]

void TRIM.SDK.FieldDefinition.SetIsUsedFor	(	TrimObject	objectToTest,
		bool	turnUsageOn
	)

Adds or removes this user field from the list of user fields for the nominated Base Object (and hence all other objects of the same type category). For example, if the nominated base object is an organization, then this method will set this user field's usage for all organization Locations.

◆ SetIsUsedForLocation()

void TRIM.SDK.FieldDefinition.SetIsUsedForLocation	(	LocationType	locationTypeForUsage,
		bool	turnUsageOn
	)

Adds or removes this user field from the list of user fields for the nominated Location Type.

◆ SetIsUsedForRecord()

void TRIM.SDK.FieldDefinition.SetIsUsedForRecord	(	RecordType	recordTypeForUsage,
		bool	turnUsageOn
	)

Adds or removes this user field from the list of user fields for the nominated Record Type.

◆ SetIsUsedForWorkflow()

void TRIM.SDK.FieldDefinition.SetIsUsedForWorkflow	(	WorkflowTemplate	templateForUsage,
		bool	turnUsageOn
	)

Adds or removes this user field from the list of user fields for the nominated Workflow Template

◆ SetIsUsedForWorkflowWithNoTemplate()

void TRIM.SDK.FieldDefinition.SetIsUsedForWorkflowWithNoTemplate ( bool turnUsageOn )

Adds or removes this user field from the list of user fields available for any workflow that is not based on a template

◆ SetNotes()

void TRIM.SDK.FieldDefinition.SetNotes	(	string	NewNotesText,
		NotesUpdateType	TypeOfNotesUpdate
	)

Updates the notes attached to this object. Typically used when a new contibution is to be combined with the existing notes, as some users only have the privilige to add to the notes, rather than overwriting them.

Implements TRIM.SDK.ITrimNotes.

◆ SetValidLocationType()

void TRIM.SDK.FieldDefinition.SetValidLocationType	(	LocationType	locType,
		bool	includeThisType
	)

Sets which type of location is valid for this user field (if it is a field of type 'Object (Location)'

Property Documentation

◆ Abbreviation

string TRIM.SDK.FieldDefinition.Abbreviation

getset

Gets or sets a string containing an abbreviation for the user field corresponding to this FieldDefinition object.

◆ AccessControlList

TrimAccessControlList? TRIM.SDK.FieldDefinition.AccessControlList

getset

◆ AllowNegative

bool TRIM.SDK.FieldDefinition.AllowNegative

getset

Gets or sets a Boolean property indicating whether numeric values are allowed to be negative (number, big number, currency and decimal formats only).

◆ AllowUpdateForDestroyed

bool TRIM.SDK.FieldDefinition.AllowUpdateForDestroyed

getset

Gets or sets a Boolean property indicating whether the value of this field can be modified on a record that has been destroyed.

◆ CanAddToNotes

bool TRIM.SDK.FieldDefinition.CanAddToNotes

get

◆ CanModifyExistingNotes

bool TRIM.SDK.FieldDefinition.CanModifyExistingNotes

get

◆ CurrencySymbol

string TRIM.SDK.FieldDefinition.CurrencySymbol

getset

Gets or sets a string containing the currency symbol to be used for fields of type currency. Leave blank to use the default currency symbol of the dataset.

◆ CustomIcon

TrimIcon TRIM.SDK.FieldDefinition.CustomIcon

getset

◆ CustomIconExternal

ExternalIcon? TRIM.SDK.FieldDefinition.CustomIconExternal

get

◆ CustomIconInternal

Icons TRIM.SDK.FieldDefinition.CustomIconInternal

get

◆ DateTimeIsUTC

bool TRIM.SDK.FieldDefinition.DateTimeIsUTC

getset

Gets or sets a boolean value indicating whether date time values should be entered, displayed and searched as if they are UTC values rather than local time.

◆ DecimalPlaces

int TRIM.SDK.FieldDefinition.DecimalPlaces

getset

Gets or sets a number corresponding to the number of decimal places to display when displaying this field (currency and decimal formats only, between 0 and 8).

◆ DefaultBoolean

bool TRIM.SDK.FieldDefinition.DefaultBoolean

get

Gets the default boolean value for this user field, if it is a boolean user field. This FieldDefinition object is a boolean user field if the property FieldDefinition.Format has the value 'ufBoolean'.

◆ DefaultCurrency

TrimCurrency TRIM.SDK.FieldDefinition.DefaultCurrency

get

Gets the default currency value for this user field, if it is a currency user field. This FieldDefinition object is a currency user field if the property FieldDefinition.Format has the value 'ufCurrency'.

◆ DefaultDate

TrimDateTime TRIM.SDK.FieldDefinition.DefaultDate

get

Gets the default date or datetime value for this user field, if it is a date or datetime user field. This FieldDefinition object is an date user field if the property FieldDefinition.Format has the value 'ufDate', and a datetime user field if FieldDefinition.Format has the value 'ufDateTime'.

◆ DefaultDecimal

TrimDecimal TRIM.SDK.FieldDefinition.DefaultDecimal

get

Gets the default decimal value for this user field, if it is a decimal user field. This FieldDefinition object is a decimal user field if the property FieldDefinition.Format has the value 'ufDecimal'.

◆ DefaultDisplay

string TRIM.SDK.FieldDefinition.DefaultDisplay

get

Gets a string representation of the default value of the user field corresponding to this FieldDefinition object in a format that is suitable for display purposes, e.g. with leading zeroes cut off.

◆ DefaultInternal

string TRIM.SDK.FieldDefinition.DefaultInternal

get

Gets a string representation of the default value of the user field corresponding to this FieldDefinition object in the same format as it is stored in the database.

◆ DefaultNumber

int TRIM.SDK.FieldDefinition.DefaultNumber

get

Gets the default integer value for this user field, if it is an integer user field. This FieldDefinition object is an integer user field if the property FieldDefinition.Format has the value 'ufNumber'.

◆ DefaultString

string TRIM.SDK.FieldDefinition.DefaultString

get

Gets the default string value for this user field, if it is a string or text user field. This FieldDefinition object is a string user field if the property FieldDefinition.Format has the value 'ufString', and a text user field if FieldDefinition.Format has the value 'ufText'.

◆ DefaultValue

UserFieldValue? TRIM.SDK.FieldDefinition.DefaultValue

getset

Gets or sets the default value for the user defined field corresponding to this FieldDefinition object.

◆ ExternalId

string TRIM.SDK.FieldDefinition.ExternalId

getset

Gets or sets a string containing the External Identification Number for the user field corresponding to this FieldDefinition object. This identifier cannot be changed through the Content Manager user interface and so guarantees your program a reliable handle to the user field aside from the URI.

◆ ForceSpellCheck

bool TRIM.SDK.FieldDefinition.ForceSpellCheck

getset

Gets or sets a boolean value indicating that when entering a value for this field, the spelling check function should be mandatory. Only applies to fields of format string using the simple verification type or fields of format text.

◆ Format

UserFieldFormats TRIM.SDK.FieldDefinition.Format

getset

Gets or sets a ufUserFieldFormats enum value indicating the format of the user field corresponding to this FieldDefinition object. The user field may be used to store boolean, currency, date, date and time, decimal, Content Manager object (currently restricted to Content Manager location), string or text values.

◆ IconId

Icons TRIM.SDK.FieldDefinition.IconId

getset

Gets or sets an Icons enumeration value to associate a standard Content Manager icon with this user field.

◆ InIDOLSchema

bool TRIM.SDK.FieldDefinition.InIDOLSchema

getset

Gets or sets a boolean property indicating if this field should be included in the IDOL metadata schema when indexing records within IDOL.

◆ InIDOLtext

bool TRIM.SDK.FieldDefinition.InIDOLtext

getset

Gets or sets a boolean value indicating whether this user-defined field has been configured to include the value in the IDOL text indexing group.

◆ IsUsedBy

string TRIM.SDK.FieldDefinition.IsUsedBy

get

Gets a string listing the objects using this user field in Content Manager. Does not include record types.

◆ IsUsedByRecordTypes

string TRIM.SDK.FieldDefinition.IsUsedByRecordTypes

get

Gets a string listing the record types using this user field in Content Manager.

◆ IsVisible

bool TRIM.SDK.FieldDefinition.IsVisible

getset

Gets the visible state of this field for the current user.

◆ Length

int TRIM.SDK.FieldDefinition.Length

getset

Gets or sets an integer containing the maximum number of characters allowed in this user field, if it is a string user field. The value of this property may not exceed 255 characters.

◆ LocationMustBeMemberOf

Location? TRIM.SDK.FieldDefinition.LocationMustBeMemberOf

getset

Gets or sets a location object that this field must be a member of. Only applies to fields of format object and type location.

◆ LocationRestriction

LocationFieldType TRIM.SDK.FieldDefinition.LocationRestriction

getset

Gets or sets a Location Field Type enumeration value indicating, for a field of format 'object (location)', whether internal or external locations are suitable

◆ LookupSet

LookupSet? TRIM.SDK.FieldDefinition.LookupSet

getset

Gets or sets a LookupSet object used to contain a set of acceptable string values for this user field, if it is a string or text user field.

◆ LowerLimit

string TRIM.SDK.FieldDefinition.LowerLimit

getset

Gets or sets a string containing the lower limit, or minimum value of this user field.

◆ Mask

string TRIM.SDK.FieldDefinition.Mask

getset

Gets or sets a string containing an edit mask to be used for this user field, if this is a string user field. The mask is a combination of normal characters with the special characters 'N,A,X,Z,\'used to restrict the format of any string entered for this field. See the Content Manager Help File for more information on the edit mask format.

◆ Name

new string TRIM.SDK.FieldDefinition.Name

getset

Gets or sets a string containing the name of the user field corresponding to this FieldDefinition object.

◆ Notes

string TRIM.SDK.FieldDefinition.Notes

getset

◆ ObjectType

BaseObjectTypes TRIM.SDK.FieldDefinition.ObjectType

getset

Gets or sets a BaseObjectTypes enum value indicating the Content Manager object type of the user field, if it is an object user field.

◆ OnlyLookupItemsInText

bool TRIM.SDK.FieldDefinition.OnlyLookupItemsInText

getset

Gets or sets a boolean value indicating that when using a lookup set, the text can only contain lookup items and no additional text. Only applies to fields of format text.

◆ PluginBrowseOnly

bool TRIM.SDK.FieldDefinition.PluginBrowseOnly

getset

Gets or sets a boolean value indicating that when entering a value for this field, the value cannot be typed bust must be selected using the KwikSelect key. Only applies to fields of format string using the addIn string verification type.

◆ PluginId

string TRIM.SDK.FieldDefinition.PluginId

getset

Gets or sets a string containing the PROGID of an COM component implementing the validation function, if this is a string user field using a COM component for validation.

◆ RecordMustBeOfType

RecordType? TRIM.SDK.FieldDefinition.RecordMustBeOfType

getset

Gets or sets a record type object that this field must have. Only applies to fields of format object and type record.

◆ SapKeySetField

string TRIM.SDK.FieldDefinition.SapKeySetField

getset

Gets or sets a string value that maps this user defined field to one of the fields in the SAP Keys extended metadata interface provided by the ArchiveLink Content Server.

◆ SearchClause

string TRIM.SDK.FieldDefinition.SearchClause

getset

Gets a string representing a user-specified clause name for this user field.

◆ SearchClauseCaption

string TRIM.SDK.FieldDefinition.SearchClauseCaption

get

Gets a string representing a user-friendly version of the the search clause name used for this user field.

◆ SearchClauseName

string TRIM.SDK.FieldDefinition.SearchClauseName

get

Gets a string representing the string to use when composing a search involving this user field.

◆ StringVerificationType

StringVerificationTypes TRIM.SDK.FieldDefinition.StringVerificationType

getset

Gets or sets a stringVerificationTypes enumerated value indicating how to validate the value of this field. Only applies to fields of format string.

◆ SubstitutionString

string TRIM.SDK.FieldDefinition.SubstitutionString

get

Gets a string value which can be used as a substitution string when encoding this field into a text expression, such as an external link paramater.

◆ UpperLimit

string TRIM.SDK.FieldDefinition.UpperLimit

getset

Gets or sets a string containing the upper limit, or maximum value of this user field.

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ FieldDefinition() [1/3]

◆ FieldDefinition() [2/3]

◆ FieldDefinition() [3/3]

Member Function Documentation

◆ CanSearch()

◆ CanSort()

◆ FindFieldBySearchClauseName()

◆ IsLocationTypeValid()

◆ IsMandatory()

◆ IsUsedFor()

◆ IsUsedForAny()

◆ NewCopy()

◆ SetIsUsedFor() [1/2]

◆ SetIsUsedFor() [2/2]

◆ SetIsUsedForLocation()

◆ SetIsUsedForRecord()

◆ SetIsUsedForWorkflow()

◆ SetIsUsedForWorkflowWithNoTemplate()

◆ SetNotes()

◆ SetValidLocationType()

Property Documentation

◆ Abbreviation

◆ AccessControlList

◆ AllowNegative

◆ AllowUpdateForDestroyed

◆ CanAddToNotes

◆ CanModifyExistingNotes

◆ CurrencySymbol

◆ CustomIcon

◆ CustomIconExternal

◆ CustomIconInternal

◆ DateTimeIsUTC

◆ DecimalPlaces

◆ DefaultBoolean

◆ DefaultCurrency

◆ DefaultDate

◆ DefaultDecimal

◆ DefaultDisplay

◆ DefaultInternal

◆ DefaultNumber

◆ DefaultString

◆ DefaultValue

◆ ExternalId

◆ ForceSpellCheck

◆ Format

◆ IconId

◆ InIDOLSchema

◆ InIDOLtext

◆ IsUsedBy

◆ IsUsedByRecordTypes

◆ IsVisible

◆ Length

◆ LocationMustBeMemberOf

◆ LocationRestriction

◆ LookupSet

◆ LowerLimit

◆ Mask

◆ Name

◆ Notes

◆ ObjectType

◆ OnlyLookupItemsInText

◆ PluginBrowseOnly

◆ PluginId

◆ RecordMustBeOfType

◆ SapKeySetField

◆ SearchClause

◆ SearchClauseCaption

◆ SearchClauseName

◆ StringVerificationType

◆ SubstitutionString

◆ UpperLimit