TRIM.SDK.ITrimLabels Interface Reference

Allows you to attach or detach a label to a Trim object More...

Inheritance diagram for TRIM.SDK.ITrimLabels:

Public Member Functions
void	ApplyUserLabel (UserLabel userLabelToApply)
	Creates a link between the nominated user label and this object. More...
void	DetachUserLabel (UserLabel userLabelToDetach)
	Removes the link between the nominated user label and this object. More...
void	AddToFavorites ()
	Adds the object to the special user label called 'Favorites' More...
void	RemoveFromFavorites ()
	Removes the object from the special user label called 'Favorites' More...
bool	ChangePositionWithinFavorites (LabelPositionChange positionChange)
	Changes the position of this object within a users list of favorite objects of this type More...
bool	ChangePositionWithinUserLabel (UserLabel userLabelToChange, LabelPositionChange positionChange)
	Changes the position of this object within a users list of objects that have been labeled with the specified user label More...

Detailed Description

Allows you to attach or detach a label to a Trim object

Member Function Documentation

AddToFavorites()

void TRIM.SDK.ITrimLabels.AddToFavorites

(

)

Adds the object to the special user label called 'Favorites'

Implemented in TRIM.SDK.WorkflowTemplate, TRIM.SDK.Workflow, TRIM.SDK.Space, TRIM.SDK.SearchForm, TRIM.SDK.Schedule, TRIM.SDK.SavedSearch, TRIM.SDK.Report, TRIM.SDK.RecordType, TRIM.SDK.Record, TRIM.SDK.Location, TRIM.SDK.Keyword, TRIM.SDK.Jurisdiction, TRIM.SDK.DocumentQueue, TRIM.SDK.ConsignmentTemplate, TRIM.SDK.Consignment, TRIM.SDK.Classification, and TRIM.SDK.ArchiveEvent.

ApplyUserLabel()

void TRIM.SDK.ITrimLabels.ApplyUserLabel

(

UserLabel

userLabelToApply

)

Creates a link between the nominated user label and this object.

Implemented in TRIM.SDK.WorkflowTemplate, TRIM.SDK.Workflow, TRIM.SDK.Space, TRIM.SDK.SearchForm, TRIM.SDK.Schedule, TRIM.SDK.SavedSearch, TRIM.SDK.Report, TRIM.SDK.RecordType, TRIM.SDK.Record, TRIM.SDK.Location, TRIM.SDK.Keyword, TRIM.SDK.Jurisdiction, TRIM.SDK.DocumentQueue, TRIM.SDK.ConsignmentTemplate, TRIM.SDK.Consignment, TRIM.SDK.Classification, and TRIM.SDK.ArchiveEvent.

ChangePositionWithinFavorites()

bool TRIM.SDK.ITrimLabels.ChangePositionWithinFavorites

(

LabelPositionChange

positionChange

)

Changes the position of this object within a users list of favorite objects of this type

Implemented in TRIM.SDK.WorkflowTemplate, TRIM.SDK.Workflow, TRIM.SDK.Space, TRIM.SDK.SearchForm, TRIM.SDK.Schedule, TRIM.SDK.SavedSearch, TRIM.SDK.Report, TRIM.SDK.RecordType, TRIM.SDK.Record, TRIM.SDK.Location, TRIM.SDK.Keyword, TRIM.SDK.Jurisdiction, TRIM.SDK.DocumentQueue, TRIM.SDK.ConsignmentTemplate, TRIM.SDK.Consignment, TRIM.SDK.Classification, and TRIM.SDK.ArchiveEvent.

ChangePositionWithinUserLabel()

bool TRIM.SDK.ITrimLabels.ChangePositionWithinUserLabel	(	UserLabel	userLabelToChange,
		LabelPositionChange	positionChange
	)

Changes the position of this object within a users list of objects that have been labeled with the specified user label

Implemented in TRIM.SDK.WorkflowTemplate, TRIM.SDK.Workflow, TRIM.SDK.Space, TRIM.SDK.SearchForm, TRIM.SDK.Schedule, TRIM.SDK.SavedSearch, TRIM.SDK.Report, TRIM.SDK.RecordType, TRIM.SDK.Record, TRIM.SDK.Location, TRIM.SDK.Keyword, TRIM.SDK.Jurisdiction, TRIM.SDK.DocumentQueue, TRIM.SDK.ConsignmentTemplate, TRIM.SDK.Consignment, TRIM.SDK.Classification, and TRIM.SDK.ArchiveEvent.

DetachUserLabel()

void TRIM.SDK.ITrimLabels.DetachUserLabel

(

UserLabel

userLabelToDetach

)

Removes the link between the nominated user label and this object.

Implemented in TRIM.SDK.WorkflowTemplate, TRIM.SDK.Workflow, TRIM.SDK.Space, TRIM.SDK.SearchForm, TRIM.SDK.Schedule, TRIM.SDK.SavedSearch, TRIM.SDK.Report, TRIM.SDK.RecordType, TRIM.SDK.Record, TRIM.SDK.Location, TRIM.SDK.Keyword, TRIM.SDK.Jurisdiction, TRIM.SDK.DocumentQueue, TRIM.SDK.ConsignmentTemplate, TRIM.SDK.Consignment, TRIM.SDK.Classification, and TRIM.SDK.ArchiveEvent.

RemoveFromFavorites()

void TRIM.SDK.ITrimLabels.RemoveFromFavorites

(

)

Removes the object from the special user label called 'Favorites'

Implemented in TRIM.SDK.WorkflowTemplate, TRIM.SDK.Workflow, TRIM.SDK.Space, TRIM.SDK.SearchForm, TRIM.SDK.Schedule, TRIM.SDK.SavedSearch, TRIM.SDK.Report, TRIM.SDK.RecordType, TRIM.SDK.Record, TRIM.SDK.Location, TRIM.SDK.Keyword, TRIM.SDK.Jurisdiction, TRIM.SDK.DocumentQueue, TRIM.SDK.ConsignmentTemplate, TRIM.SDK.Consignment, TRIM.SDK.Classification, and TRIM.SDK.ArchiveEvent.