A helper class that encapsulates the settings to use when copying a record. More...

Inheritance diagram for TRIM.SDK.CopyRecordOptions:

Public Member Functions
	CopyRecordOptions (Database fromDB, bool forNewVersion)
	Construct a default set of copy options for either the Record.CreateNewCopy() or Record.CreateNewVersion() methods. More...

	CopyRecordOptions (Database fromDB, CopyType typeOfCopy)
	Construct a default set of copy options for either the Record.CreateNewCopy(), Record.CreateNewPart() or Record.CreateNewVersion() methods. More...

void	setSuggestedNumbers (string compressedNumber, string uncompressedNumber)
	Sets a suggested number pattern to be used when creating the copy or new version More...

void	setNewVersionDocument (InputDocument usingDocument)
	Sets an alternative document to use when creating a new version of a record. If not specified the latest revision of the document attached to the source record will be used. More...

void	setNewVersionDocument (string documentFileName)
	Sets an alternative document to use when creating a new version of a record. If not specified the latest revision of the document attached to the source record will be used. More...

Public Member Functions inherited from TRIM.SDK.TrimSDKObject
	TrimSDKObject ()

Properties
bool	CopySecurity `[get, set]`
	Gets or sets a boolean value indicating whether the security profile should be copied to the new record. More...

bool	CopyNotes `[get, set]`
	Gets or sets a boolean value indicating whether the notes should be copied to the new record. More...

bool	CopyRelatedTo `[get, set]`
	Gets or sets a boolean value indicating whether the 'related to' relationships should be copied to the new record. More...

bool	CopyDisposition `[get, set]`
	Gets or sets a boolean value indicating whether the archival disposition should be copied to the new record. More...

bool	CopySchedule `[get, set]`
	Gets or sets a boolean value indicating whether the retention schedule should be copied to the new record. More...

bool	CopyActions `[get, set]`
	Gets or sets a boolean value indicating whether assigned record actions should be copied to the new record. More...

bool	CopyContacts `[get, set]`
	Gets or sets a boolean value indicating whether contacts should be copied to the new record. More...

bool	CopyCustomFieldValues `[get, set]`
	Gets or sets a boolean value indicating whether custom field definition field values profile should be copied to the new record. More...

bool	CopyDates `[get, set]`
	Gets or sets a boolean value indicating whether key record dates (registered, created) should be copied to the new record. More...

bool	CopyUserLabels `[get, set]`
	Gets or sets a boolean value indicating whether user labels should be copied to the new record. More...

bool	CopyKeywords `[get, set]`
	Gets or sets a boolean value indicating whether keywords should be copied to the new record. More...

bool	CopyClassification `[get, set]`
	Gets or sets a boolean value indicating whether the classification should be copied to the new record. More...

bool	CopyAccessControls `[get, set]`
	Gets or sets a boolean value indicating whether access controls should be copied to the new record. More...

bool	CopyExclusions `[get, set]`
	Gets or sets a boolean value indicating whether exclusions should be copied to the new record. More...

bool	CopyAlternateContainers `[get, set]`
	Gets or sets a boolean value indicating whether alternative container relationships should be copied to the new record. More...

CopyRelationship	RelateCopyToOriginal `[get, set]`
	Gets or sets a boolean value indicating whether the copied record should be related to the original using the 'copy of' relationship (does not apply to new versions). More...

bool	PurgeOldVersionRevisions `[get, set]`
	Gets or sets a boolean value indicating whether the original version should have all revisions automatically purged as part of creating the new version. More...

bool	CopyDocument `[get, set]`
	Gets or sets a boolean value indicating whether any electronic document should be copied to the new record More...

Record?	ContainerRecord `[get, set]`
	Gets or sets Record object that will be the container used for any new record created. If not specified, the new record will be placed in the same container as the original record. More...

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

Detailed Description

A helper class that encapsulates the settings to use when copying a record.

Constructor & Destructor Documentation

◆ CopyRecordOptions() [1/2]

TRIM.SDK.CopyRecordOptions.CopyRecordOptions	(	Database	fromDB,
		bool	forNewVersion
	)

Construct a default set of copy options for either the Record.CreateNewCopy() or Record.CreateNewVersion() methods.

◆ CopyRecordOptions() [2/2]

TRIM.SDK.CopyRecordOptions.CopyRecordOptions	(	Database	fromDB,
		CopyType	typeOfCopy
	)

Construct a default set of copy options for either the Record.CreateNewCopy(), Record.CreateNewPart() or Record.CreateNewVersion() methods.

Member Function Documentation

◆ setNewVersionDocument() [1/2]

void TRIM.SDK.CopyRecordOptions.setNewVersionDocument ( InputDocument usingDocument )

Sets an alternative document to use when creating a new version of a record. If not specified the latest revision of the document attached to the source record will be used.

◆ setNewVersionDocument() [2/2]

void TRIM.SDK.CopyRecordOptions.setNewVersionDocument ( string documentFileName )

Sets an alternative document to use when creating a new version of a record. If not specified the latest revision of the document attached to the source record will be used.

◆ setSuggestedNumbers()

void TRIM.SDK.CopyRecordOptions.setSuggestedNumbers	(	string	compressedNumber,
		string	uncompressedNumber
	)

Sets a suggested number pattern to be used when creating the copy or new version

Property Documentation

◆ ContainerRecord

Record? TRIM.SDK.CopyRecordOptions.ContainerRecord

getset

Gets or sets Record object that will be the container used for any new record created. If not specified, the new record will be placed in the same container as the original record.

◆ CopyAccessControls

bool TRIM.SDK.CopyRecordOptions.CopyAccessControls

getset

Gets or sets a boolean value indicating whether access controls should be copied to the new record.

◆ CopyActions

bool TRIM.SDK.CopyRecordOptions.CopyActions

getset

Gets or sets a boolean value indicating whether assigned record actions should be copied to the new record.

◆ CopyAlternateContainers

bool TRIM.SDK.CopyRecordOptions.CopyAlternateContainers

getset

Gets or sets a boolean value indicating whether alternative container relationships should be copied to the new record.

◆ CopyClassification

bool TRIM.SDK.CopyRecordOptions.CopyClassification

getset

Gets or sets a boolean value indicating whether the classification should be copied to the new record.

◆ CopyContacts

bool TRIM.SDK.CopyRecordOptions.CopyContacts

getset

Gets or sets a boolean value indicating whether contacts should be copied to the new record.

◆ CopyCustomFieldValues

bool TRIM.SDK.CopyRecordOptions.CopyCustomFieldValues

getset

Gets or sets a boolean value indicating whether custom field definition field values profile should be copied to the new record.

◆ CopyDates

bool TRIM.SDK.CopyRecordOptions.CopyDates

getset

Gets or sets a boolean value indicating whether key record dates (registered, created) should be copied to the new record.

◆ CopyDisposition

bool TRIM.SDK.CopyRecordOptions.CopyDisposition

getset

Gets or sets a boolean value indicating whether the archival disposition should be copied to the new record.

◆ CopyDocument

bool TRIM.SDK.CopyRecordOptions.CopyDocument

getset

Gets or sets a boolean value indicating whether any electronic document should be copied to the new record

◆ CopyExclusions

bool TRIM.SDK.CopyRecordOptions.CopyExclusions

getset

Gets or sets a boolean value indicating whether exclusions should be copied to the new record.

◆ CopyKeywords

bool TRIM.SDK.CopyRecordOptions.CopyKeywords

getset

Gets or sets a boolean value indicating whether keywords should be copied to the new record.

◆ CopyNotes

bool TRIM.SDK.CopyRecordOptions.CopyNotes

getset

Gets or sets a boolean value indicating whether the notes should be copied to the new record.

◆ CopyRelatedTo

bool TRIM.SDK.CopyRecordOptions.CopyRelatedTo

getset

Gets or sets a boolean value indicating whether the 'related to' relationships should be copied to the new record.

◆ CopySchedule

bool TRIM.SDK.CopyRecordOptions.CopySchedule

getset

Gets or sets a boolean value indicating whether the retention schedule should be copied to the new record.

◆ CopySecurity

bool TRIM.SDK.CopyRecordOptions.CopySecurity

getset

Gets or sets a boolean value indicating whether the security profile should be copied to the new record.

◆ CopyUserLabels

bool TRIM.SDK.CopyRecordOptions.CopyUserLabels

getset

Gets or sets a boolean value indicating whether user labels should be copied to the new record.

◆ PurgeOldVersionRevisions

bool TRIM.SDK.CopyRecordOptions.PurgeOldVersionRevisions

getset

Gets or sets a boolean value indicating whether the original version should have all revisions automatically purged as part of creating the new version.

◆ RelateCopyToOriginal

CopyRelationship TRIM.SDK.CopyRecordOptions.RelateCopyToOriginal

getset

Gets or sets a boolean value indicating whether the copied record should be related to the original using the 'copy of' relationship (does not apply to new versions).

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ CopyRecordOptions() [1/2]

◆ CopyRecordOptions() [2/2]

Member Function Documentation

◆ setNewVersionDocument() [1/2]

◆ setNewVersionDocument() [2/2]

◆ setSuggestedNumbers()

Property Documentation

◆ ContainerRecord

◆ CopyAccessControls

◆ CopyActions

◆ CopyAlternateContainers

◆ CopyClassification

◆ CopyContacts

◆ CopyCustomFieldValues

◆ CopyDates

◆ CopyDisposition

◆ CopyDocument

◆ CopyExclusions

◆ CopyKeywords

◆ CopyNotes

◆ CopyRelatedTo

◆ CopySchedule

◆ CopySecurity

◆ CopyUserLabels

◆ PurgeOldVersionRevisions

◆ RelateCopyToOriginal