A check in style describes a set of defaults to be used when creating Records More...

Inheritance diagram for TRIM.SDK.CheckinStyle:

Public Member Functions
	CheckinStyle (Database database, TrimURI uri)
	Constructs using the email link style - if you specify a matter record then this automatically synchronizes with all sub-folders of the matter More...

	CheckinStyle (Database database, string name)
	Constructs using the email link style - if you specify a matter record then this automatically synchronizes with all sub-folders of the matter. This form allows you to specify a record type to be used when creating records associated with this check in place More...

	CheckinStyle (Database database)
	Constructs using the email link style, allowing a classification to be selected as the target for filing More...

	CheckinStyle (Record matterRecordOrFolder)
	Constructs using the email link style, allowing a classification to be selected as the target for filing. This form allows you to specify a record type to be used when creating records associated with this check in place More...

	CheckinStyle (Record matterRecordOrFolder, RecordType recordTypeForFilingHere)
	Allows you to construct a generic check in style using the nominated record type More...

	CheckinStyle (Classification classTarget)

	CheckinStyle (Classification classTarget, RecordType recordTypeForFilingHere)

	CheckinStyle (RecordType recordTypeForFilingHere)

UserFieldValue	GetFieldValue (FieldDefinition userFieldType)
	Gets the value of the nominated user-defined field for this object. More...

void	SetFieldValue (FieldDefinition userFieldType, UserFieldValue newValue)
	Sets the value of the nominated user-defined field for this object. More...

string	GetFieldValueAsString (FieldDefinition userFieldType, StringDisplayType fieldValueStringType, bool useHTMLEscapeChars)
	Gets a string representation of a user-defined field value in a format appropriate for a specific use. More...

CheckinPlace	FindPlace (CheckinPlaceTypes placeType, string placeId)
	Looks to see if there is an existing check in place for the current user that has the nominated placeType and identifier. More...

CheckinPlace	FindOrCreatePlace (CheckinPlaceTypes placeType, string placeId)
	Looks to see if there is an existing check in place for the current user that has the nominated placeType and identifier. If no place exists, it will create and save a new place into the database. More...

Record	SetupNewRecord (InputDocument doc)
	Initializes a new Record based in this check in style. More...

Record	SetupNewRecord (InputDocument doc, bool delayAnyContainerCreation)
	Initializes a new Record based in this check in style. This form allows you to delay the creation of a container for the new record until your app has set some more metadata properties on the record. In this case you will need to use the AllocateContainer function to set the container on the record at some later stage. More...

void	AllocateContainer (Record forNewRecord)
	Sets the container on the supplied record based on the check in style container allocation policy. More...

void	AllocateContainer (Record forNewRecord, bool crossProcessLock)
	Sets the container on the supplied record based on the check in style container allocation policy. You should set the crossProcessLock to true if this Check In Style could be being used simultaneously by other processes. 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
ActionDef?	Action `[get, set]`
	Gets or sets an action object which will be attached to records created using this check in style. More...

Location?	Addressee `[get, set]`
	Gets or sets the location that should be used as the addressee for the records created from this check in style. More...

Record?	AlternativeContainer `[get, set]`
	Gets or sets the record that should be used as the alternative container for the records created from this check in style. More...

Location?	Assignee `[get, set]`
	Gets or sets a location to be used as the assignee of the record when creating records using this check in style. More...

bool	AutoRender `[get, set]`
	Gets or sets a boolean value indicating if a request should be created to automatically render the input document to a long term preservation format. More...

Classification?	Classification `[get, set]`
	Gets or sets a classification object which will be applied to records created using this check in style More...

Record?	Container `[get, set]`
	Gets or sets a record object representing the container which will be applied to records created using this check in style More...

bool	ContainerCreation `[get, set]`
	Gets or sets a boolean value indicating whether containers should be created when creating new records using this check in style. More...

DateIntervalSing	ContainerDateInterval `[get, set]`
	Gets or sets an enumerated value indicating whether the date range for the container should be a day, a week, a month or a year when creating new records using this check in style More...

bool	ContainerHasDateRange `[get, set]`
	Gets or sets a boolean parameter indicating whether containers should be allocated based on a date range for contained items when creating new records using this check in style. More...

bool	ContainerPerOwner `[get, set]`
	Gets or sets a boolean value indicating whether the classification should allocate a new container based on the owner location of the record being created using this check in style More...

FieldDefinition?	ContainerPerUserField `[get, set]`
	Gets or sets a field definition object indicating that the classification should allocate a new container based on the value of the specified user defined field of the record being created using this check in style More...

int	ContainerSizeThreshold `[get, set]`
	Gets or sets a number which determines the maximum number of contained items for containers created when when creating new records using this check in style More...

string	ContainerTitleTemplate `[get, set]`
	Gets or sets a string value containing a template to be used when constructing the title of the container record for a record created using this check in style. More...

RecordType?	ContainerType `[get, set]`
	Gets or sets the record type to be used when creating containers to be used when creating new records using this check in style. More...

string	Description `[get]`
	Gets a string describing this check in style More...

bool	FinalizeOnSave `[get, set]`
	Gets or sets a boolean value indicating if records created using this check in style should be finalized. More...

string	GpsLocation `[get, set]`
	Gets or sets a geography value which will be attached to records created using this check in style More...

WorkflowTemplate?	InitiateWorkflow `[get, set]`
	Gets or sets a workflow template which will be used to initiate a workflow whenever creating records created using this check in style. More...

bool	IsMatterSubfolder `[get]`
	Gets a boolean object indicating that this check in style represents a subfolder of a matter, which means it will be automatically generated from the matter template. More...

bool	IsMatterTemplate `[get]`
	Gets a boolean object indicating that this check in style represents a matter template, used to generate check in styles for all the subfolders of the matter specified. More...

Jurisdiction?	Jurisdiction `[get, set]`
	Gets or sets a jurisdiction to be applied to records created using this check in style. More...

bool	MailAttachmentsOnly `[get, set]`
	Gets or sets a boolean value indicating that when cataloguing an email using this check in style, just catalog each attachment as a separate record, ignoring the mail envelope. More...

MailPersistence	MailCleanupStyle `[get, set]`
	Gets or sets a MailPersistence enumeration value indicating what to do with email after it has been been registered in Content Manager. More...

bool	MakePrivate `[get, set]`
	Gets or sets a boolean value indicating if records created using this check in style should have the view document access control set to private. More...

Record?	Matter `[get]`
	Gets a record object indicating the matter associated with this check in style. A matter check in style will automatically create check in styles for all subfolders of that matter. More...

new string	Name `[get, set]`
	Gets or sets a string value used when displaying this check in style. More...

RecordType?	RecordType `[get, set]`
	Gets or sets a record type object which will be used when creating records using this check in style More...

Schedule?	RetentionSchedule `[get, set]`
	Gets or sets a schedule object which will be attached to records created unsing this check in style More...

string	Security `[get, set]`
	Gets or sets a string listing the security profile to be used when creating records using this check in style. More...

SetAuthorOptions	SetAuthorOption `[get, set]`
	Gets or sets the a setAuthorOptions enumerated value indicating what type of default to use for the author of records created from this check in style. More...

bool	ShowDataEntryForm `[get, set]`
	Gets or sets a boolean variable indicating that when creating a new record for an item, a data entry form for that record should be displayed. Ignored for server-side capture processing. More...

Location?	SpecificAuthor `[get, set]`
	Gets or sets the location that should be used as the specific author for the records created from this check in style. More...

Location?	StyleOwner `[get, set]`
	Gets or sets a location object representing the owner of this check in style. If not specified, the check in style is public. More...

RecordType?	SubFolderRecordType `[get, set]`
	Gets a record type object used as the record type for the automatically generated subfolder check in styles that are created for a matter check in style More...

bool	UseForServerMailCalendar `[get, set]`
	Gets or sets a boolean variable indicating that this style will be used by the Mail Link server to capture appointments in the Calendar folder More...

bool	UseForServerMailConversationHistory `[get, set]`
	Gets or sets a boolean variable indicating that this style will be used by the Mail Link server to capture mail in the Conversation History folder More...

bool	UseForServerMailFolders `[get, set]`
	Gets or sets a boolean variable indicating that this style will be used by the Mail Link server to capture mail in general folders More...

bool	UseForServerMailSentItems `[get, set]`
	Gets or sets a boolean variable indicating that this style will be used by the Mail Link server to capture mail in the Sent Items folder More...

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...

Detailed Description

A check in style describes a set of defaults to be used when creating Records

Constructor & Destructor Documentation

◆ CheckinStyle() [1/8]

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

Constructs using the email link style - if you specify a matter record then this automatically synchronizes with all sub-folders of the matter

◆ CheckinStyle() [2/8]

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

Constructs using the email link style - if you specify a matter record then this automatically synchronizes with all sub-folders of the matter. This form allows you to specify a record type to be used when creating records associated with this check in place

◆ CheckinStyle() [3/8]

TRIM.SDK.CheckinStyle.CheckinStyle ( Database database )

Constructs using the email link style, allowing a classification to be selected as the target for filing

◆ CheckinStyle() [4/8]

TRIM.SDK.CheckinStyle.CheckinStyle ( Record matterRecordOrFolder )

Constructs using the email link style, allowing a classification to be selected as the target for filing. This form allows you to specify a record type to be used when creating records associated with this check in place

◆ CheckinStyle() [5/8]

TRIM.SDK.CheckinStyle.CheckinStyle	(	Record	matterRecordOrFolder,
		RecordType	recordTypeForFilingHere
	)

Allows you to construct a generic check in style using the nominated record type

◆ CheckinStyle() [6/8]

TRIM.SDK.CheckinStyle.CheckinStyle ( Classification classTarget )

◆ CheckinStyle() [7/8]

TRIM.SDK.CheckinStyle.CheckinStyle	(	Classification	classTarget,
		RecordType	recordTypeForFilingHere
	)

◆ CheckinStyle() [8/8]

TRIM.SDK.CheckinStyle.CheckinStyle ( RecordType recordTypeForFilingHere )

Member Function Documentation

◆ AllocateContainer() [1/2]

void TRIM.SDK.CheckinStyle.AllocateContainer ( Record forNewRecord )

Sets the container on the supplied record based on the check in style container allocation policy.

◆ AllocateContainer() [2/2]

void TRIM.SDK.CheckinStyle.AllocateContainer	(	Record	forNewRecord,
		bool	crossProcessLock
	)

Sets the container on the supplied record based on the check in style container allocation policy. You should set the crossProcessLock to true if this Check In Style could be being used simultaneously by other processes.

◆ FindOrCreatePlace()

CheckinPlace TRIM.SDK.CheckinStyle.FindOrCreatePlace	(	CheckinPlaceTypes	placeType,
		string	placeId
	)

Looks to see if there is an existing check in place for the current user that has the nominated placeType and identifier. If no place exists, it will create and save a new place into the database.

◆ FindPlace()

CheckinPlace TRIM.SDK.CheckinStyle.FindPlace	(	CheckinPlaceTypes	placeType,
		string	placeId
	)

Looks to see if there is an existing check in place for the current user that has the nominated placeType and identifier.

◆ GetFieldValue()

UserFieldValue TRIM.SDK.CheckinStyle.GetFieldValue ( FieldDefinition userFieldType )

Gets the value of the nominated user-defined field for this object.

Implements TRIM.SDK.ITrimUserFields.

◆ GetFieldValueAsString()

string TRIM.SDK.CheckinStyle.GetFieldValueAsString	(	FieldDefinition	userFieldType,
		StringDisplayType	fieldValueStringType,
		bool	useHTMLEscapeChars
	)

Gets a string representation of a user-defined field value in a format appropriate for a specific use.

Implements TRIM.SDK.ITrimUserFields.

◆ SetFieldValue()

void TRIM.SDK.CheckinStyle.SetFieldValue	(	FieldDefinition	userFieldType,
		UserFieldValue	newFieldValue
	)

Sets the value of the nominated user-defined field for this object.

Implements TRIM.SDK.ITrimUserFields.

◆ SetupNewRecord() [1/2]

Record TRIM.SDK.CheckinStyle.SetupNewRecord ( InputDocument doc )

Initializes a new Record based in this check in style.

◆ SetupNewRecord() [2/2]

Record TRIM.SDK.CheckinStyle.SetupNewRecord	(	InputDocument	doc,
		bool	delayAnyContainerCreation
	)

Initializes a new Record based in this check in style. This form allows you to delay the creation of a container for the new record until your app has set some more metadata properties on the record. In this case you will need to use the AllocateContainer function to set the container on the record at some later stage.

Property Documentation

◆ Action

ActionDef? TRIM.SDK.CheckinStyle.Action

getset

Gets or sets an action object which will be attached to records created using this check in style.

◆ Addressee

Location? TRIM.SDK.CheckinStyle.Addressee

getset

Gets or sets the location that should be used as the addressee for the records created from this check in style.

◆ AlternativeContainer

Record? TRIM.SDK.CheckinStyle.AlternativeContainer

getset

Gets or sets the record that should be used as the alternative container for the records created from this check in style.

◆ Assignee

Location? TRIM.SDK.CheckinStyle.Assignee

getset

Gets or sets a location to be used as the assignee of the record when creating records using this check in style.

◆ AutoRender

bool TRIM.SDK.CheckinStyle.AutoRender

getset

Gets or sets a boolean value indicating if a request should be created to automatically render the input document to a long term preservation format.

◆ Classification

Classification? TRIM.SDK.CheckinStyle.Classification

getset

Gets or sets a classification object which will be applied to records created using this check in style

◆ Container

Record? TRIM.SDK.CheckinStyle.Container

getset

Gets or sets a record object representing the container which will be applied to records created using this check in style

◆ ContainerCreation

bool TRIM.SDK.CheckinStyle.ContainerCreation

getset

Gets or sets a boolean value indicating whether containers should be created when creating new records using this check in style.

◆ ContainerDateInterval

DateIntervalSing TRIM.SDK.CheckinStyle.ContainerDateInterval

getset

Gets or sets an enumerated value indicating whether the date range for the container should be a day, a week, a month or a year when creating new records using this check in style

◆ ContainerHasDateRange

bool TRIM.SDK.CheckinStyle.ContainerHasDateRange

getset

Gets or sets a boolean parameter indicating whether containers should be allocated based on a date range for contained items when creating new records using this check in style.

◆ ContainerPerOwner

bool TRIM.SDK.CheckinStyle.ContainerPerOwner

getset

Gets or sets a boolean value indicating whether the classification should allocate a new container based on the owner location of the record being created using this check in style

◆ ContainerPerUserField

FieldDefinition? TRIM.SDK.CheckinStyle.ContainerPerUserField

getset

Gets or sets a field definition object indicating that the classification should allocate a new container based on the value of the specified user defined field of the record being created using this check in style

◆ ContainerSizeThreshold

int TRIM.SDK.CheckinStyle.ContainerSizeThreshold

getset

Gets or sets a number which determines the maximum number of contained items for containers created when when creating new records using this check in style

◆ ContainerTitleTemplate

string TRIM.SDK.CheckinStyle.ContainerTitleTemplate

getset

Gets or sets a string value containing a template to be used when constructing the title of the container record for a record created using this check in style.

◆ ContainerType

RecordType? TRIM.SDK.CheckinStyle.ContainerType

getset

Gets or sets the record type to be used when creating containers to be used when creating new records using this check in style.

◆ Description

string TRIM.SDK.CheckinStyle.Description

get

Gets a string describing this check in style

◆ FinalizeOnSave

bool TRIM.SDK.CheckinStyle.FinalizeOnSave

getset

Gets or sets a boolean value indicating if records created using this check in style should be finalized.

◆ GpsLocation

string TRIM.SDK.CheckinStyle.GpsLocation

getset

Gets or sets a geography value which will be attached to records created using this check in style

◆ InitiateWorkflow

WorkflowTemplate? TRIM.SDK.CheckinStyle.InitiateWorkflow

getset

Gets or sets a workflow template which will be used to initiate a workflow whenever creating records created using this check in style.

◆ IsMatterSubfolder

bool TRIM.SDK.CheckinStyle.IsMatterSubfolder

get

Gets a boolean object indicating that this check in style represents a subfolder of a matter, which means it will be automatically generated from the matter template.

◆ IsMatterTemplate

bool TRIM.SDK.CheckinStyle.IsMatterTemplate

get

Gets a boolean object indicating that this check in style represents a matter template, used to generate check in styles for all the subfolders of the matter specified.

◆ Jurisdiction

Jurisdiction? TRIM.SDK.CheckinStyle.Jurisdiction

getset

Gets or sets a jurisdiction to be applied to records created using this check in style.

◆ MailAttachmentsOnly

bool TRIM.SDK.CheckinStyle.MailAttachmentsOnly

getset

Gets or sets a boolean value indicating that when cataloguing an email using this check in style, just catalog each attachment as a separate record, ignoring the mail envelope.

◆ MailCleanupStyle

MailPersistence TRIM.SDK.CheckinStyle.MailCleanupStyle

getset

Gets or sets a MailPersistence enumeration value indicating what to do with email after it has been been registered in Content Manager.

◆ MakePrivate

bool TRIM.SDK.CheckinStyle.MakePrivate

getset

Gets or sets a boolean value indicating if records created using this check in style should have the view document access control set to private.

◆ Matter

Record? TRIM.SDK.CheckinStyle.Matter

get

Gets a record object indicating the matter associated with this check in style. A matter check in style will automatically create check in styles for all subfolders of that matter.

◆ Name

new string TRIM.SDK.CheckinStyle.Name

getset

Gets or sets a string value used when displaying this check in style.

◆ RecordType

RecordType? TRIM.SDK.CheckinStyle.RecordType

getset

Gets or sets a record type object which will be used when creating records using this check in style

◆ RetentionSchedule

Schedule? TRIM.SDK.CheckinStyle.RetentionSchedule

getset

Gets or sets a schedule object which will be attached to records created unsing this check in style

◆ Security

string TRIM.SDK.CheckinStyle.Security

getset

Gets or sets a string listing the security profile to be used when creating records using this check in style.

◆ SetAuthorOption

SetAuthorOptions TRIM.SDK.CheckinStyle.SetAuthorOption

getset

Gets or sets the a setAuthorOptions enumerated value indicating what type of default to use for the author of records created from this check in style.

◆ ShowDataEntryForm

bool TRIM.SDK.CheckinStyle.ShowDataEntryForm

getset

Gets or sets a boolean variable indicating that when creating a new record for an item, a data entry form for that record should be displayed. Ignored for server-side capture processing.

◆ SpecificAuthor

Location? TRIM.SDK.CheckinStyle.SpecificAuthor

getset

Gets or sets the location that should be used as the specific author for the records created from this check in style.

◆ StyleOwner

Location? TRIM.SDK.CheckinStyle.StyleOwner

getset

Gets or sets a location object representing the owner of this check in style. If not specified, the check in style is public.

◆ SubFolderRecordType

RecordType? TRIM.SDK.CheckinStyle.SubFolderRecordType

getset

Gets a record type object used as the record type for the automatically generated subfolder check in styles that are created for a matter check in style

◆ UseForServerMailCalendar

bool TRIM.SDK.CheckinStyle.UseForServerMailCalendar

getset

Gets or sets a boolean variable indicating that this style will be used by the Mail Link server to capture appointments in the Calendar folder

◆ UseForServerMailConversationHistory

bool TRIM.SDK.CheckinStyle.UseForServerMailConversationHistory

getset

Gets or sets a boolean variable indicating that this style will be used by the Mail Link server to capture mail in the Conversation History folder

◆ UseForServerMailFolders

bool TRIM.SDK.CheckinStyle.UseForServerMailFolders

getset

Gets or sets a boolean variable indicating that this style will be used by the Mail Link server to capture mail in general folders

◆ UseForServerMailSentItems

bool TRIM.SDK.CheckinStyle.UseForServerMailSentItems

getset

Gets or sets a boolean variable indicating that this style will be used by the Mail Link server to capture mail in the Sent Items folder

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ CheckinStyle() [1/8]

◆ CheckinStyle() [2/8]

◆ CheckinStyle() [3/8]

◆ CheckinStyle() [4/8]

◆ CheckinStyle() [5/8]

◆ CheckinStyle() [6/8]

◆ CheckinStyle() [7/8]

◆ CheckinStyle() [8/8]

Member Function Documentation

◆ AllocateContainer() [1/2]

◆ AllocateContainer() [2/2]

◆ FindOrCreatePlace()

◆ FindPlace()

◆ GetFieldValue()

◆ GetFieldValueAsString()

◆ SetFieldValue()

◆ SetupNewRecord() [1/2]

◆ SetupNewRecord() [2/2]

Property Documentation

◆ Action

◆ Addressee

◆ AlternativeContainer

◆ Assignee

◆ AutoRender

◆ Classification

◆ Container

◆ ContainerCreation

◆ ContainerDateInterval

◆ ContainerHasDateRange

◆ ContainerPerOwner

◆ ContainerPerUserField

◆ ContainerSizeThreshold

◆ ContainerTitleTemplate

◆ ContainerType

◆ Description

◆ FinalizeOnSave

◆ GpsLocation

◆ InitiateWorkflow

◆ IsMatterSubfolder

◆ IsMatterTemplate

◆ Jurisdiction

◆ MailAttachmentsOnly

◆ MailCleanupStyle

◆ MakePrivate

◆ Matter

◆ Name

◆ RecordType

◆ RetentionSchedule

◆ Security

◆ SetAuthorOption

◆ ShowDataEntryForm

◆ SpecificAuthor

◆ StyleOwner

◆ SubFolderRecordType

◆ UseForServerMailCalendar

◆ UseForServerMailConversationHistory

◆ UseForServerMailFolders

◆ UseForServerMailSentItems