Defines externally developed executables and add-ins that are linked into Content Manager More...

Inheritance diagram for TRIM.SDK.ExternalLink:

Public Member Functions
	ExternalLink (Database database, TrimURI uri)

	ExternalLink (Database database, string name)

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

void	SetDocument (string fromFileName)
	Set the document associated with this Trim object as a copy of the supplied file name More...

void	LoadDocumentIntoClientCache ()
	Loads the document associated with this object into the client document cache, if one is available. More...

string	GetDocumentPathInClientCache (Events logAccessAs)
	Gets the path to a copy of the document associated with this object within the client document cache - logs access according to the supplied history log type. More...

string	GetDocumentPathInWGSCache (Events logAccessAs)

ExtractDocument	GetExtractDocument ()

string	Extract (string outputDocumentName)

	ExternalLink (Database inDatabase, ExternalLinkType initializeAsType)

void	SetPathDetails (PathTypes pt, string subFolder, string fileName)
	Use this to set details of the file to be used for the addin, applies to the .NET addin and the executable link types More...

bool	IsUsedBy (TrimMainObject baseObject)
	Indicates if this external link is used the specified object. More...

bool	IsUsedByAllRecordTypes ()
	Indicates if this external link is used by all record types. More...

bool	IsUsedByRecordType (RecordType recordType)
	Indicates if this external link is used by the specified record type. More...

bool	IsUsedByLocationType (LocationType locType)
	Indicates if this external link is used by the specified location type More...

bool	IsUsedByOtherObjectTypeType (BaseObjectTypes objectType)
	Indicates if this external link is used by the specified object type (used for objects other than record or location) More...

void	SetIsUsedByRecordTypes (TrimURIList recordTypeArray, bool allButThese)
	Sets this external link to be used one or more record types (or use the allButThese to specify by exclusion) More...

void	SetIsUsedByLocationType (LocationType locType, bool includeThisOne)
	Sets this external link to be used by specified location type More...

void	SetIsUsedByOtherObjectType (BaseObjectTypes objectType, bool includeThisOne)
	Sets this external link to be used by specified object type (other than record or location) More...

string	GetCommandLineParameters (RecordType recordType)
	Gets the command line parameters to be used when executing a link for a record of the specified type. Used for executable and comparison link types only. If this returns blank, you should also check the DefaultRecordParameters property. More...

void	SetCommandLineParameters (RecordType recordType, string newParameters)
	Sets the command line parameters to be used when executing a link for a record of the specified type. Used for executable and comparison link types only. Pass a blank string if you wish for records of this type to use the parameters in the DefaultRecordParameters property. More...

string	GetCommandLineParameters (LocationType locType)
	Gets the command line parameters to be used when executing a link for a location of the specified type. Used for executable and comparison link types only. More...

void	SetCommandLineParameters (LocationType locType, string newParameters)
	Sets the command line parameters to be used when executing a link for a location of the specified type. Used for executable and comparison link types only. More...

string	GetCommandLineParameters (BaseObjectTypes objectType)
	Gets the command line parameters to be used when executing a link for an object of the specified type (other than record or location). Used for executable and comparison link types only. More...

void	SetCommandLineParameters (BaseObjectTypes objectType, string newParameters)
	Sets the command line parameters to be used when executing a link for an object of the specified type (other than record or location). Used for executable and comparison link types only. More...

string	FormatURL (TrimMainObject obj)
	Formats the URL string for a browserURL type of external link for the specified object More...

string	FormatParameters (TrimMainObject obj)
	Formats the command line parameters for an executable or browserURL type of external link for the specified object 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	AlwaysUseTaggedFormat `[get, set]`
	Gets or sets a boolean property indicating whether the link should always get parameters as if doing tagged processing even when only a single item is selected for command processing. More...

string	AssemblyClassName `[get, set]`
	Gets or sets a string containing the class name of the assembly for a .NET add-in. More...

string	AssemblyPath `[get, set]`
	Gets or sets a string containing the path name of the .NET assembly for this .NET add-in. More...

int	CommandId `[get]`
	Gets the id allocated when Content Manager sets up defined add-ins. More...

string	ComProgId `[get, set]`
	Gets or sets a string containing the progID of the COM component - for COM based addins. More...

TrimDateTime	DateModified `[get]`
	Gets the date and time of the last modification made to the deployable link More...

string	DefaultRecordParameters `[get, set]`
	Gets or sets a string value that will be used as a default command line parameter string for all record types. More...

string	Description `[get]`
	Gets a string describing details of this external link. More...

long	DocumentSize `[get]`
	Gets the file size (in bytes) of the document that is used to store the deployable link More...

string	ExecutablePath `[get, set]`
	Gets or sets a string containing the path of the executable for this external link - for executable addIns. More...

string	Extension `[get]`
	Gets the file type of the document that is used to store the deployable link More...

string	FileTypes `[get, set]`
	Gets or sets a string value that will be used to filter usage of this add-in to only apply to the specified document types. Applies only to executable type links. More...

bool	HasUserInterface `[get, set]`
	Gets or sets a boolean property indicating whether any of the add-in entry points displays a user interface More...

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

bool	IgnoreLoadError `[get, set]`
	Gets or sets a boolean property indicating whether to ignore errors when loading the link (making the link unavailable if an error occurs) More...

string	LinkName `[get, set]`
	Gets or sets a string containing the name of this external link. More...

string	LinkPathFileName `[get]`
	Gets a string indicating the filename of the add-in (no folder included) More...

string	LinkPathSubFolder `[get]`
	Gets a string representing a sub folder within the nominated path which is used to store the link file More...

PathTypes	LinkPathType `[get]`
	Gets a pathTypes enumerated value indicating whether the property indicating whether any of the add-in entry points displays a user interface More...

ExternalLinkType	LinkType `[get]`
	Gets an ExternalLinkType enumerated value corresponding to the type of this external link. More...

bool	OkReadOnly `[get, set]`
	Gets or sets a boolean property indicating whether the link should execute commands on objects that are read only More...

UserPermissions	Permission `[get, set]`
	Gets or sets a UserPermissions enumeration value indicating that the current user needs to have to specified permission in order to execute any commands associated with this link. More...

string	RootURL `[get, set]`
	Gets or sets a string containing the root URL of the browser link. More...

bool	RunAsAdmin `[get, set]`
	Gets or sets a boolean property indicating whether the link should run as if it has full administration rights (irrespective of the user who is currently logged in) More...

ElectronicStore?	Store `[get]`
	Gets the document store that is used to store the deployable link More...

string	StoreID `[get]`
	Gets the ID of the document in the document store that is used to store the deployable link More...

bool	SupportsMTA `[get, set]`
	Gets or sets a boolean property indicating whether the COM component supports running using the multi-threaded apartment model. More...

bool	SupportsTagged `[get, set]`
	Gets or sets a boolean property indicating whether the link handles tagged mode when running commands. More...

string	TaggedCommandLine `[get, set]`
	Gets or sets a string property that represents the command line to use when tagged processing. You should run the user interface manually to determine available substitution strings. More...

string	WorkFolder `[get, set]`
	Gets or sets a string defining the folder to be used as the current folder to be used when running this external link (depending on WorkFolderPathType). More...

bool	CanModifyExistingNotes `[get]`

bool	CanAddToNotes `[get]`

string	Notes `[get, set]`

TrimAccessControlList?	AccessControlList `[get, set]`

bool	IsDocumentInClientCache `[get]`

string	DocumentPathInClientCache `[get]`

string	DocumentPathInWGSCache `[get]`

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.ITrimDocument
bool	IsDocumentInClientCache `[get]`
	Gets a boolean value indicating whether the document associated with this object is currently inside the client document cache. More...

string	DocumentPathInClientCache `[get]`
	Gets a String value representing the path to a copy of the document associated with this object within the client document cache. For records, access is logged as a 'View'. 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 externally developed executables and add-ins that are linked into Content Manager

Constructor & Destructor Documentation

◆ ExternalLink() [1/3]

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

◆ ExternalLink() [2/3]

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

◆ ExternalLink() [3/3]

TRIM.SDK.ExternalLink.ExternalLink	(	Database	inDatabase,
		ExternalLinkType	initializeAsType
	)

Member Function Documentation

◆ Extract()

string TRIM.SDK.ExternalLink.Extract ( string outputDocumentName )

◆ FormatParameters()

string TRIM.SDK.ExternalLink.FormatParameters ( TrimMainObject obj )

Formats the command line parameters for an executable or browserURL type of external link for the specified object

◆ FormatURL()

string TRIM.SDK.ExternalLink.FormatURL ( TrimMainObject obj )

Formats the URL string for a browserURL type of external link for the specified object

◆ GetCommandLineParameters() [1/3]

string TRIM.SDK.ExternalLink.GetCommandLineParameters ( BaseObjectTypes objectType )

Gets the command line parameters to be used when executing a link for an object of the specified type (other than record or location). Used for executable and comparison link types only.

◆ GetCommandLineParameters() [2/3]

string TRIM.SDK.ExternalLink.GetCommandLineParameters ( LocationType locType )

Gets the command line parameters to be used when executing a link for a location of the specified type. Used for executable and comparison link types only.

◆ GetCommandLineParameters() [3/3]

string TRIM.SDK.ExternalLink.GetCommandLineParameters ( RecordType recordType )

Gets the command line parameters to be used when executing a link for a record of the specified type. Used for executable and comparison link types only. If this returns blank, you should also check the DefaultRecordParameters property.

◆ GetDocumentPathInClientCache()

string TRIM.SDK.ExternalLink.GetDocumentPathInClientCache ( Events logAccessAs )

Gets the path to a copy of the document associated with this object within the client document cache - logs access according to the supplied history log type.

Implements TRIM.SDK.ITrimDocument.

◆ GetDocumentPathInWGSCache()

string TRIM.SDK.ExternalLink.GetDocumentPathInWGSCache ( Events logAccessAs )

◆ GetExtractDocument()

ExtractDocument TRIM.SDK.ExternalLink.GetExtractDocument ( )

◆ IsUsedBy()

bool TRIM.SDK.ExternalLink.IsUsedBy ( TrimMainObject baseObject )

Indicates if this external link is used the specified object.

◆ IsUsedByAllRecordTypes()

bool TRIM.SDK.ExternalLink.IsUsedByAllRecordTypes ( )

Indicates if this external link is used by all record types.

◆ IsUsedByLocationType()

bool TRIM.SDK.ExternalLink.IsUsedByLocationType ( LocationType locType )

Indicates if this external link is used by the specified location type

◆ IsUsedByOtherObjectTypeType()

bool TRIM.SDK.ExternalLink.IsUsedByOtherObjectTypeType ( BaseObjectTypes objectType )

Indicates if this external link is used by the specified object type (used for objects other than record or location)

◆ IsUsedByRecordType()

bool TRIM.SDK.ExternalLink.IsUsedByRecordType ( RecordType recordType )

Indicates if this external link is used by the specified record type.

◆ LoadDocumentIntoClientCache()

void TRIM.SDK.ExternalLink.LoadDocumentIntoClientCache ( )

Loads the document associated with this object into the client document cache, if one is available.

Implements TRIM.SDK.ITrimDocument.

◆ SetCommandLineParameters() [1/3]

void TRIM.SDK.ExternalLink.SetCommandLineParameters	(	BaseObjectTypes	objectType,
		string	newParameters
	)

Sets the command line parameters to be used when executing a link for an object of the specified type (other than record or location). Used for executable and comparison link types only.

◆ SetCommandLineParameters() [2/3]

void TRIM.SDK.ExternalLink.SetCommandLineParameters	(	LocationType	locType,
		string	newParameters
	)

Sets the command line parameters to be used when executing a link for a location of the specified type. Used for executable and comparison link types only.

◆ SetCommandLineParameters() [3/3]

void TRIM.SDK.ExternalLink.SetCommandLineParameters	(	RecordType	recordType,
		string	newParameters
	)

Sets the command line parameters to be used when executing a link for a record of the specified type. Used for executable and comparison link types only. Pass a blank string if you wish for records of this type to use the parameters in the DefaultRecordParameters property.

◆ SetDocument()

void TRIM.SDK.ExternalLink.SetDocument ( string fromFileName )

Set the document associated with this Trim object as a copy of the supplied file name

Implements TRIM.SDK.ITrimDocument.

◆ SetIsUsedByLocationType()

void TRIM.SDK.ExternalLink.SetIsUsedByLocationType	(	LocationType	locType,
		bool	includeThisOne
	)

Sets this external link to be used by specified location type

◆ SetIsUsedByOtherObjectType()

void TRIM.SDK.ExternalLink.SetIsUsedByOtherObjectType	(	BaseObjectTypes	objectType,
		bool	includeThisOne
	)

Sets this external link to be used by specified object type (other than record or location)

◆ SetIsUsedByRecordTypes()

void TRIM.SDK.ExternalLink.SetIsUsedByRecordTypes	(	TrimURIList	recordTypeArray,
		bool	allButThese
	)

Sets this external link to be used one or more record types (or use the allButThese to specify by exclusion)

◆ SetNotes()

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

◆ SetPathDetails()

void TRIM.SDK.ExternalLink.SetPathDetails	(	PathTypes	pt,
		string	subFolder,
		string	fileName
	)

Use this to set details of the file to be used for the addin, applies to the .NET addin and the executable link types

Property Documentation

◆ AccessControlList

TrimAccessControlList? TRIM.SDK.ExternalLink.AccessControlList

getset

◆ AlwaysUseTaggedFormat

bool TRIM.SDK.ExternalLink.AlwaysUseTaggedFormat

getset

Gets or sets a boolean property indicating whether the link should always get parameters as if doing tagged processing even when only a single item is selected for command processing.

◆ AssemblyClassName

string TRIM.SDK.ExternalLink.AssemblyClassName

getset

Gets or sets a string containing the class name of the assembly for a .NET add-in.

◆ AssemblyPath

string TRIM.SDK.ExternalLink.AssemblyPath

getset

Gets or sets a string containing the path name of the .NET assembly for this .NET add-in.

◆ CanAddToNotes

bool TRIM.SDK.ExternalLink.CanAddToNotes

get

◆ CanModifyExistingNotes

bool TRIM.SDK.ExternalLink.CanModifyExistingNotes

get

◆ CommandId

int TRIM.SDK.ExternalLink.CommandId

get

Gets the id allocated when Content Manager sets up defined add-ins.

◆ ComProgId

string TRIM.SDK.ExternalLink.ComProgId

getset

Gets or sets a string containing the progID of the COM component - for COM based addins.

◆ CustomIcon

TrimIcon TRIM.SDK.ExternalLink.CustomIcon

getset

◆ CustomIconExternal

ExternalIcon? TRIM.SDK.ExternalLink.CustomIconExternal

get

◆ CustomIconInternal

Icons TRIM.SDK.ExternalLink.CustomIconInternal

get

◆ DateModified

TrimDateTime TRIM.SDK.ExternalLink.DateModified

get

Gets the date and time of the last modification made to the deployable link

◆ DefaultRecordParameters

string TRIM.SDK.ExternalLink.DefaultRecordParameters

getset

Gets or sets a string value that will be used as a default command line parameter string for all record types.

◆ Description

string TRIM.SDK.ExternalLink.Description

get

Gets a string describing details of this external link.

◆ DocumentPathInClientCache

string TRIM.SDK.ExternalLink.DocumentPathInClientCache

get

◆ DocumentPathInWGSCache

string TRIM.SDK.ExternalLink.DocumentPathInWGSCache

get

◆ DocumentSize

long TRIM.SDK.ExternalLink.DocumentSize

get

Gets the file size (in bytes) of the document that is used to store the deployable link

◆ ExecutablePath

string TRIM.SDK.ExternalLink.ExecutablePath

getset

Gets or sets a string containing the path of the executable for this external link - for executable addIns.

◆ Extension

string TRIM.SDK.ExternalLink.Extension

get

Gets the file type of the document that is used to store the deployable link

◆ FileTypes

string TRIM.SDK.ExternalLink.FileTypes

getset

Gets or sets a string value that will be used to filter usage of this add-in to only apply to the specified document types. Applies only to executable type links.

◆ HasUserInterface

bool TRIM.SDK.ExternalLink.HasUserInterface

getset

Gets or sets a boolean property indicating whether any of the add-in entry points displays a user interface

◆ IconId

Icons TRIM.SDK.ExternalLink.IconId

getset

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

◆ IgnoreLoadError

bool TRIM.SDK.ExternalLink.IgnoreLoadError

getset

Gets or sets a boolean property indicating whether to ignore errors when loading the link (making the link unavailable if an error occurs)

◆ IsDocumentInClientCache

bool TRIM.SDK.ExternalLink.IsDocumentInClientCache

get

◆ LinkName

string TRIM.SDK.ExternalLink.LinkName

getset

Gets or sets a string containing the name of this external link.

◆ LinkPathFileName

string TRIM.SDK.ExternalLink.LinkPathFileName

get

Gets a string indicating the filename of the add-in (no folder included)

◆ LinkPathSubFolder

string TRIM.SDK.ExternalLink.LinkPathSubFolder

get

Gets a string representing a sub folder within the nominated path which is used to store the link file

◆ LinkPathType

PathTypes TRIM.SDK.ExternalLink.LinkPathType

get

Gets a pathTypes enumerated value indicating whether the property indicating whether any of the add-in entry points displays a user interface

◆ LinkType

ExternalLinkType TRIM.SDK.ExternalLink.LinkType

get

Gets an ExternalLinkType enumerated value corresponding to the type of this external link.

◆ Notes

string TRIM.SDK.ExternalLink.Notes

getset

◆ OkReadOnly

bool TRIM.SDK.ExternalLink.OkReadOnly

getset

Gets or sets a boolean property indicating whether the link should execute commands on objects that are read only

◆ Permission

UserPermissions TRIM.SDK.ExternalLink.Permission

getset

Gets or sets a UserPermissions enumeration value indicating that the current user needs to have to specified permission in order to execute any commands associated with this link.

◆ RootURL

string TRIM.SDK.ExternalLink.RootURL

getset

Gets or sets a string containing the root URL of the browser link.

◆ RunAsAdmin

bool TRIM.SDK.ExternalLink.RunAsAdmin

getset

Gets or sets a boolean property indicating whether the link should run as if it has full administration rights (irrespective of the user who is currently logged in)

◆ Store

ElectronicStore? TRIM.SDK.ExternalLink.Store

get

Gets the document store that is used to store the deployable link

◆ StoreID

string TRIM.SDK.ExternalLink.StoreID

get

Gets the ID of the document in the document store that is used to store the deployable link

◆ SupportsMTA

bool TRIM.SDK.ExternalLink.SupportsMTA

getset

Gets or sets a boolean property indicating whether the COM component supports running using the multi-threaded apartment model.

◆ SupportsTagged

bool TRIM.SDK.ExternalLink.SupportsTagged

getset

Gets or sets a boolean property indicating whether the link handles tagged mode when running commands.

◆ TaggedCommandLine

string TRIM.SDK.ExternalLink.TaggedCommandLine

getset

Gets or sets a string property that represents the command line to use when tagged processing. You should run the user interface manually to determine available substitution strings.

◆ WorkFolder

string TRIM.SDK.ExternalLink.WorkFolder

getset

Gets or sets a string defining the folder to be used as the current folder to be used when running this external link (depending on WorkFolderPathType).

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ExternalLink() [1/3]

◆ ExternalLink() [2/3]

◆ ExternalLink() [3/3]

Member Function Documentation

◆ Extract()

◆ FormatParameters()

◆ FormatURL()

◆ GetCommandLineParameters() [1/3]

◆ GetCommandLineParameters() [2/3]

◆ GetCommandLineParameters() [3/3]

◆ GetDocumentPathInClientCache()

◆ GetDocumentPathInWGSCache()

◆ GetExtractDocument()

◆ IsUsedBy()

◆ IsUsedByAllRecordTypes()

◆ IsUsedByLocationType()

◆ IsUsedByOtherObjectTypeType()

◆ IsUsedByRecordType()

◆ LoadDocumentIntoClientCache()

◆ SetCommandLineParameters() [1/3]

◆ SetCommandLineParameters() [2/3]

◆ SetCommandLineParameters() [3/3]

◆ SetDocument()

◆ SetIsUsedByLocationType()

◆ SetIsUsedByOtherObjectType()

◆ SetIsUsedByRecordTypes()

◆ SetNotes()

◆ SetPathDetails()

Property Documentation

◆ AccessControlList

◆ AlwaysUseTaggedFormat

◆ AssemblyClassName

◆ AssemblyPath

◆ CanAddToNotes

◆ CanModifyExistingNotes

◆ CommandId

◆ ComProgId

◆ CustomIcon

◆ CustomIconExternal

◆ CustomIconInternal

◆ DateModified

◆ DefaultRecordParameters

◆ Description

◆ DocumentPathInClientCache

◆ DocumentPathInWGSCache

◆ DocumentSize

◆ ExecutablePath

◆ Extension

◆ FileTypes

◆ HasUserInterface

◆ IconId

◆ IgnoreLoadError

◆ IsDocumentInClientCache

◆ LinkName

◆ LinkPathFileName

◆ LinkPathSubFolder

◆ LinkPathType

◆ LinkType

◆ Notes

◆ OkReadOnly

◆ Permission

◆ RootURL

◆ RunAsAdmin

◆ Store

◆ StoreID

◆ SupportsMTA

◆ SupportsTagged

◆ TaggedCommandLine

◆ WorkFolder