A user label is a user-defined tag that can be applied to any Content Manager object to provide a logical grouping of those objects (similar to favorites) More...

Inheritance diagram for TRIM.SDK.UserLabel:

Public Member Functions
	UserLabel (Database database, TrimURI uri)

	UserLabel (Database database, string name)

	UserLabel (Database database)

	UserLabel (Location newLabelOwner)

UserLabel	NewLowerLevel ()

void	Init (Location initWith)

void	DeleteEx (bool deleteLowerLevels)

void	SetItemsAs (BaseObjectTypes forObjectType, TrimURIList objectUriList)
	Allows you to set the list of items attached to this label (for the specified object type) to correspond to array passed in. You should only use this function for main object types that implement the ITrimLabels interface 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...

Properties
bool	Attachable `[get]`
	Gets a boolean value indicating if the currently logged in user can attach this label to anything. More...

TrimDateTime	DateCreated `[get]`
	Gets the date that the label was created More...

bool	Detachable `[get]`
	Gets a boolean value indicating if the currently logged in user can detach this label to anything. More...

string	FullName `[get]`
	Gets or sets the name for this label - the combination of user and name must be unique More...

bool	HasChildLabels `[get]`
	Gets a boolean value indicating if this user label has any subordinate user labels. More...

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

UserLabelType	LabelType `[get]`
	Gets the type of label More...

new string	Name `[get, set]`
	Gets or sets the name for this label - the combination of user and name must be unique within the same parent label More...

Location?	Owner `[get, set]`
	Gets or sets the location that owns/created this label More...

UserLabel?	ParentLabel `[get, set]`
	Gets or sets the name for this label - the combination of user and name must be unique More...

TrimAccessControlList?	AccessControlList `[get, set]`

bool	CanModifyExistingNotes `[get]`

bool	CanAddToNotes `[get]`

string	Notes `[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

A user label is a user-defined tag that can be applied to any Content Manager object to provide a logical grouping of those objects (similar to favorites)

Constructor & Destructor Documentation

◆ UserLabel() [1/4]

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

◆ UserLabel() [2/4]

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

◆ UserLabel() [3/4]

TRIM.SDK.UserLabel.UserLabel ( Database database )

◆ UserLabel() [4/4]

TRIM.SDK.UserLabel.UserLabel ( Location newLabelOwner )

Member Function Documentation

◆ DeleteEx()

void TRIM.SDK.UserLabel.DeleteEx ( bool deleteLowerLevels )

◆ Init()

void TRIM.SDK.UserLabel.Init ( Location initWith )

◆ NewLowerLevel()

UserLabel TRIM.SDK.UserLabel.NewLowerLevel ( )

◆ SetItemsAs()

void TRIM.SDK.UserLabel.SetItemsAs	(	BaseObjectTypes	forObjectType,
		TrimURIList	objectUriList
	)

Allows you to set the list of items attached to this label (for the specified object type) to correspond to array passed in. You should only use this function for main object types that implement the ITrimLabels interface

◆ SetNotes()

void TRIM.SDK.UserLabel.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.

Property Documentation

◆ AccessControlList

TrimAccessControlList? TRIM.SDK.UserLabel.AccessControlList

getset

◆ Attachable

bool TRIM.SDK.UserLabel.Attachable

get

Gets a boolean value indicating if the currently logged in user can attach this label to anything.

◆ CanAddToNotes

bool TRIM.SDK.UserLabel.CanAddToNotes

get

◆ CanModifyExistingNotes

bool TRIM.SDK.UserLabel.CanModifyExistingNotes

get

◆ CustomIcon

TrimIcon TRIM.SDK.UserLabel.CustomIcon

getset

◆ CustomIconExternal

ExternalIcon? TRIM.SDK.UserLabel.CustomIconExternal

get

◆ CustomIconInternal

Icons TRIM.SDK.UserLabel.CustomIconInternal

get

◆ DateCreated

TrimDateTime TRIM.SDK.UserLabel.DateCreated

get

Gets the date that the label was created

◆ Detachable

bool TRIM.SDK.UserLabel.Detachable

get

Gets a boolean value indicating if the currently logged in user can detach this label to anything.

◆ FullName

string TRIM.SDK.UserLabel.FullName

get

Gets or sets the name for this label - the combination of user and name must be unique

◆ HasChildLabels

bool TRIM.SDK.UserLabel.HasChildLabels

get

Gets a boolean value indicating if this user label has any subordinate user labels.

◆ IconId

Icons TRIM.SDK.UserLabel.IconId

getset

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

◆ LabelType

UserLabelType TRIM.SDK.UserLabel.LabelType

get

Gets the type of label

◆ Name

new string TRIM.SDK.UserLabel.Name

getset

Gets or sets the name for this label - the combination of user and name must be unique within the same parent label

◆ Notes

string TRIM.SDK.UserLabel.Notes

getset

◆ Owner

Location? TRIM.SDK.UserLabel.Owner

getset

Gets or sets the location that owns/created this label

◆ ParentLabel

UserLabel? TRIM.SDK.UserLabel.ParentLabel

getset

Gets or sets the name for this label - the combination of user and name must be unique

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ UserLabel() [1/4]

◆ UserLabel() [2/4]

◆ UserLabel() [3/4]

◆ UserLabel() [4/4]

Member Function Documentation

◆ DeleteEx()

◆ Init()

◆ NewLowerLevel()

◆ SetItemsAs()

◆ SetNotes()

Property Documentation

◆ AccessControlList

◆ Attachable

◆ CanAddToNotes

◆ CanModifyExistingNotes

◆ CustomIcon

◆ CustomIconExternal

◆ CustomIconInternal

◆ DateCreated

◆ Detachable

◆ FullName

◆ HasChildLabels

◆ IconId

◆ LabelType

◆ Name

◆ Notes

◆ Owner

◆ ParentLabel