The Location object is the second most important object in the Content Manager Object Model. It is used to record the various relationships between people and places and records. There are many types of locations as indicated by the TypeOfLocation enumeration More...

Inheritance diagram for TRIM.SDK.Location:

Public Member Functions
	Location (Database database, TrimURI uri)

	Location (Database database, string name)

	Location (Database database)

void	AddRelationship (Location relatedLocation, LocRelationshipType relationshipType, bool makeThisTheDefaultRelationship)
	Add a relationship to the location More...

void	RemoveRelationship (Location relatedLocation, LocRelationshipType relationshipType)
	Remove a specific relationship with the specified location More...

void	RemoveRelationship (Location relatedLocation)
	Remove all relationships with the specified location More...

void	RemoveAllRelationships ()
	Remove all relationships More...

bool	HasPermission (UserPermissions checkForPermission)
	Flag to indicate whether the permission is valid More...

bool	HasRelationship (Location relatedLocation, LocRelationshipType relationshipType)
	Flag to indicate whether there is a relationship More...

void	DeleteEx (Location replaceLocationWith, bool removeAnyRequests, bool removeAnyAccessControls, bool copyEmailAddressesToReplacement, bool copyAssociationsToReplacement)
	An extended version of the Delete function. More...

void	Deactivate ()
	De-activate removes login permissions for a location, removes any outstanding record requests, removes them from access controls and removes their login user name. This function will automatically commit any changes. More...

void	SetPermission (UserPermissions permission, bool turnOn)
	Set the permission More...

	Location (Database database, LocationType initializeAsType)

Location	NewCopy ()

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

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

void	SetActiveDateRange (TrimDateTime validFromDate, TrimDateTime validToDate)
	Sets the date range for which this object is active. Note that only the date component of the date and time is relevant for active date ranges. More...

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 label, LabelPositionChange positionChange)
	Changes the position of this object within a users list of objects that have been labeled with the specified user label 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...

Static Public Member Functions
static Location	FindLocationByLDAPDN (Database db, string distinguishedName)
	A static function to find a location with the supplied LDAP distinguished name More...

static Location	FindLocationByEmailAddress (Database db, string emailAddress)
	A static function to find the most recently added location with a matching internet-style email address. More...

Properties
string	ActualBarcode `[get]`
	Gets a string containing the internal Content Manager Barcode of this Location. More...

string	AdditionalLogin `[get, set]`
	Gets or sets a string containing the additional Network Login by which this location may log in to the Content Manager Dataset. More...

Location?	Administrator `[get]`
	Gets the Location for which this Location holds a relationship of type 'Administered By'. More...

string	AfterHoursPhoneNumber `[get, set]`
	Gets or sets a string containing the home number of this Location. More...

string	AllAdministrators `[get]`
	Gets a string listing all locations that are administrators of this location. More...

string	AllMembers `[get]`
	Gets a string listing all locations that are members of this location. More...

string	AllMemberships `[get]`
	Gets a string listing all locations that this location is a member of. More...

string	AllMembershipsRecursive `[get]`
	Gets a string listing all locations that this location is a member of, and all locations that those locations are a member of, etc). More...

UserTypes	BasedOnUserType `[get]`
	Gets a UserTypes value which determines the underlying user type of this Location (only relevant if the UserType is a custom one). More...

bool	CanDeliverDirect `[get, set]`
	Gets or sets a boolean property indicating whether delivery requests can be handled by direct delivery to the request location, rather than via a transit location More...

bool	CanLogin `[get, set]`
	Gets or sets a Boolean value indicating whether this Location can log in to the Content Manager Context Dataset. More...

bool	CanViewAllDetails `[get]`
	Gets a boolean property indicating whether the current user can view all the details of this location. More...

Location?	Committee `[get]`
	Gets the Location of Location Type 'Committee' for which this Location holds a relationship of type 'Member Of'. If there is more than one, it returns the Location designated as the default committee. Use the Location.AddRelationship method to create relationships between Locations, through which this property may be set. More...

int	CutoffTime `[get, set]`
	Gets or sets the time of day (in seconds past midnight) at which requests are cut-off and must be processed the following day. More...

TrimDateTime	DateAccessModified `[get]`
	Gets a datetime property indicating when the most recent change was made to the security profile, permissions or group membership for this location. More...

TrimDateTime	DateOfBirth `[get, set]`
	Gets or sets the date of birth of this Location. More...

Jurisdiction?	DefaultJurisdiction `[get, set]`
	Gets or sets the default jurisdiction of this location. A location can either have a default jurisdiction or a default jurisdiction group. More...

bool	DeliverContainersOnly `[get, set]`
	Gets or sets a boolean property indicating whether deliver requests are only support for container records (folders and boxes) rather than individual documents. More...

Location?	DeliveryLocation `[get]`
	Gets a location property which represents the location for staging pickup/delivery requests More...

string	EmailAddress `[get, set]`
	Gets a string containing the email address of this Location. If there is more than one email address in the Electronic Addresses for this location, the default email address is returned. If there is no default, the latest added email address is returned. More...

string	FaxNumber `[get, set]`
	Gets or sets a string containing the fax number of this Location. More...

string	FirstInitial `[get]`
	First initial of this Location. More...

string	ForeignBarcode `[get, set]`
	Gets or sets a string containing an external system's barcodes for this Location. For multiple barcodes, separate each with a semi-colon. No barcode can be longer than 30 characters. More...

string	FormalPreamble `[get]`
	Gets a string containing a form of this Location's name to be used in formal correspondence, to complete the salutation: 'Dear ...'. An example formal preamble could be: 'Mr. Abbott', so that the salutation becomes: 'Dear Mr. Abbott'. Note: This property is set automatically by Content Manager. For the title to be included in the formal preamble you must ensure the 'Display any Title' option is checked in Tools - System Options - Locations. More...

string	FormattedAddress `[get]`
	Gets a string containing the formatted address of this Location. This is by default the postal address of the location if there is one, otherwise the street address. It contains the country name in ISO format. More...

string	FormattedName `[get]`
	Gets a string containing the Display Name of this Location. The format of the Display Name is dependent on the system settings for 'Display and Reporting Format for names of People' under Tools - Content Manager Administration - System Options - Locations Tab. More...

string	FullFormattedName `[get]`
	Gets a string containing the Full Description of this Location. The Full Description consists of the Location's organization and Display Name. The Display Name is contained alone in the property Location.FormattedName More...

Gender	GenderValue `[get, set]`
	Gets or sets a gnGender enum value indicating the gender of this Location. More...

string	GivenNames `[get, set]`
	Gets or sets a string containing the given names of this Location. More...

string	GpsLocation `[get, set]`
	Gets or sets a geography value representing the GPS reference point for this location More...

bool	HasAValidLogin `[get]`
	Gets a boolean property indicating whether this location has a valid login. More...

string	HoldingOrganizationName `[get]`
	Gets a string representing the name of the holding organization for this location. This is based on the default parent organization if it exists. More...

string	HomeDataset `[get, set]`
	Gets or sets a string value indicating, for a visitor login, the id of the dataset that is the home dataset that the visitor normally works with. More...

string	Honorific `[get, set]`
	Gets or sets a string containing the title of this Location (for example, Mr., Ms., Dr. etc). More...

string	IdNumber `[get, set]`
	Gets or sets a string containing the unique ID number for this Location More...

string	InformalPreamble `[get]`
	Gets a string containing a form of this Location's name to be used in informal correspondence, to complete the salutation: 'Dear ...'. An example informal preamble could be: 'Peter', so that the salutation becomes: 'Dear Peter'. More...

string	Initials `[get, set]`
	Gets or sets a string containing the full set of initials of this Location. More...

string	InternetMailAddress `[get]`
	Gets a string containing the email address of this Location which is of email Type 'Internet'. If there is more than one Internet email address in the Electronic Addresses for this location, the default Internet email address is returned. If there is no default, the latest added Internet email address is returned. Create a new LocEAddress child object of EAddress Type 'etEAdressType.etMail' and SubType 'SMTP' to add a new Internet email address for this Location. More...

bool	IsVisitor `[get, set]`
	Gets or sets a boolean value indicating if this user is a visitor login from the same managed service provider. More...

bool	IsWithin `[get, set]`
	Gets or sets a Boolean value indicating whether this Location is internal. More...

string	JobDescription `[get, set]`
	Gets or sets a string containing the Job Title of this Location (for example, Chief Executive Officer). More...

bool	KeepAddressHistory `[get, set]`
	Gets or sets a Boolean value indicating whether a history of address changes for this Location should be kept. When the Address History is enabled, modifying an existing LocAddress will cause a new LocAddress child object containing the old address to be automatically created and set to inactive. The LocAddress object that was modified contains the new address and remains active. More...

TrimDateTime	LatestLogin `[get]`
	Gets a datetime value indicating when this location most recently logged in. More...

string	LdapSynchDN `[get, set]`
	Gets or sets the LDAP Distinguished Name associated with this locations (used for LDAP Synchronization) More...

bool	LdapSynchEnabled `[get, set]`
	Gets or sets a boolean value indicating whether LDAP synchronization is enabled for this location. More...

TrimDateTime	LdapSynchLastUpdated `[get, set]`
	Gets or sets a datetime value indicating when this location was last updated by the LDAP Synchronization tool. More...

string	LoginDetails `[get]`
	Gets a string containing the login details for this Location including 'login enabled' status and user type. The format of the string varies according to various circumstances of the location. More...

TrimDateTime	LoginExpires `[get, set]`
	Gets or sets the date the login for this Location will expire, if it is a time limited login. More...

string	LogsInAs `[get, set]`
	Gets or sets a string containing the Network Login by which this Location may log in to the Content Manager Dataset. More...

string	LongHonorific `[get, set]`
	Gets or sets a string containing the longer form of the title of this Location (for example, Mister ). More...

string	MobileNumber `[get, set]`
	Gets or sets a string containing the cell/mobile number of this Location. More...

string	NickName `[get, set]`
	Gets or sets the string containing the unique name or abbreviation of this Location. More...

string	OldPostalAddresses `[get]`
	Gets a string containing all previous mailing addresses of this location. More...

string	OldPostalAddressesISO `[get]`
	Gets a string containing all previous mailing addresses of this location in ISO format. More...

string	OldStreetAddresses `[get]`
	Gets a string containing all previous street addresses of this location. More...

string	OldStreetAddressesISO `[get]`
	Gets a string containing all previous street addresses of this location in ISO format. More...

bool	PermissionsCustomized `[get]`
	Gets a boolean property indicating if this user permissions have been customized to be different from a normal user of this type More...

string	PhoneNumber `[get, set]`
	Gets or sets a string containing the main telephone number of this Location. Mobile, fax and home telephone numbers are held in the mobileNo, faxNo and ahPhoneNo properties, respectively. More...

Location?	Position `[get]`
	Gets the Location of Location Type 'Position' for which this Location holds a relationship of type 'Member Of'. If there is more than one, it returns the Location designated as the default position. Use the Location.AddRelationship method to create relationships between Locations, through which this property may be set. More...

string	PostalAddress `[get]`
	Gets a string containing the formatted postal address of this location. More...

string	PostNominal `[get, set]`
	Gets or sets a string containing the suffix of this Location (for example, BA, PhD etc). More...

Location?	ProjectTeam `[get]`
	Gets the Location of Location Type 'Project Team' for which this Location holds a relationship of type 'Member Of'. If there is more than one, it returns the Location designated as the default project team. Use the Location.AddRelationship method to create relationships between Locations, through which this property may be set. More...

Record?	ProviderContainer `[get, set]`
	Gets or sets a Record Container which will be used when automatically capturing electronic activity log files from storage providers. More...

RecordType?	ProviderLogRecordType `[get, set]`
	Gets or sets a Record Type which will be used when automatically capturing electronic activity log files from storage providers. More...

long	RequestResponseHigh `[get, set]`
	Gets or sets the time interval (in seconds) allowed for servicing of high priority requests. More...

long	RequestResponseLow `[get, set]`
	Gets or sets the time interval (in seconds) allowed for servicing of low priority requests. More...

long	RequestResponseMedium `[get, set]`
	Gets or sets the time interval (in seconds) allowed for servicing of medium priority requests. More...

bool	RequestsNeedApproval `[get, set]`
	Gets or sets a boolean property indicating whether requests for records that are located at this location (home) need to be approved by a Request administrator. More...

TrimDateTime	ReviewDate `[get, set]`
	Gets the date this Location's settings are due to be reviewed (for example, when a Temporary Staff Member is due to leave the organization). More...

string	Salutation `[get, set]`
	Gets or sets a string containing a custom greeting by which this Location is to be addressed in correspondence. For example:'Dear President'. More...

string	SecurityKeys `[get]`
	Gets a comma-separated string listing a set of record viewing access keys held by this user. More...

string	SecurityString `[get, set]`
	Gets or sets a string listing the security level and security caveats assigned to this Location, delimited by commas ','. The first element listed is always the security level, followed by the caveats. More...

string	SortName `[get, set]`
	Gets or sets the string containing the sort name of this Location. This is the name that appears in the Locations List Pane. More...

string	StreetAddress `[get]`
	Gets a string containing the formatted street address of this location. More...

Location?	Supervisor `[get]`
	Gets the Location for which this Location holds a relationship of type 'Supervised By'. Use the Location.AddRelationship method to create relationships between Locations, through which this property may be set. More...

string	Surname `[get, set]`
	Gets or sets a string containing the full surname (including any prefix) of this Location. More...

string	SurnameNoPrefix `[get, set]`
	Gets or sets a string containing the non prefix part of the surname of this Location. For example 'Garderen' is the non prefix part of the full surname 'van Garderen'. More...

string	SurnamePrefix `[get, set]`
	Gets or sets a string containing the prefix part of the surname of this Location. For example 'van' is the prefix part of the full surname 'van Garderen'. More...

LocationType	TypeOfLocation `[get, set]`
	Gets or sets the enum value containing the location type of this Location, for example: Person. More...

Location?	Unit `[get, set]`
	Gets the Location of Location Type 'organization' for which this Location holds a relationship of type 'Member Of'. If there is more than one, it returns the Location designated as the default organization. More...

Location?	UseAddressOf `[get, set]`
	Gets or sets a pre-existing Location from whom this Location's Street and Mailing Addresses are copied. More...

bool	UsedForStatistics `[get, set]`
	Gets or sets a boolean value indicating whether this location is to be used for aggregating statistics. More...

Location?	UseProfileOf `[get, set]`
	Gets or sets a pre-existing internal Location from whom this Location's Security and Access Permission Details are copied and set. More...

UserLicenseTypes	UserLicenseType `[get]`
	Gets ane enumerated value which determines which of the license seat counts is consumed by this user. More...

UserTypes	UserType `[get, set]`
	Gets or sets a utUserTypes value which determines the access permissions of this Location. More...

string	ViewPaneId `[get]`
	Gets a string containing the View Pane ID of this Location. This is used by Content Manager as a key for storing which fields are displayed in the Locations List Window for this Location. More...

string	WebPage `[get, set]`
	Gets a string containing the web page URL of this Location. If there is more than one web page in the Electronic Addresses for this location, the default web page is returned. If there is no default, the latest added web page is returned. More...

Location?	Workgroup `[get]`
	Gets the Location of Location Type 'Workgroup' for which this Location holds a relationship of type 'Member Of'. If there is more than one, it returns the Location designated as the default workgroup. Use the Location.AddRelationship method to create relationships between Locations, through which this property may be set. More...

LocationAddresses	ChildAddresses `[get]`
	Get the list of Physical Addresses More...

LocationEAddresses	ChildEAddresses `[get]`
	Get the list of Electronic Addresses More...

string	DataEntryFormDefinition `[get]`
	Get the xml data entry definition. This will be obsoleted shortly, use the FormDefinition property instead More...

bool	CanModifyExistingNotes `[get]`

bool	CanAddToNotes `[get]`

string	Notes `[get, set]`

TrimSecurityProfile?	SecurityProfile `[get, set]`

TrimAccessControlList?	AccessControlList `[get, set]`

TrimDateTime	DateActiveFrom `[get]`

TrimDateTime	DateActiveTo `[get]`

string	ActiveDateRangeDescription `[get]`

bool	IsActive `[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.ITrimSecurity
TrimSecurityProfile	SecurityProfile `[get, set]`
	Gets or sets the security profile 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.ITrimActiveDates
TrimDateTime	DateActiveFrom `[get]`
	Gets the TrimDateTime property corresponding to when this object first became active. If the returned value is blank, it indicates that the item has always been active (until the DateActiveTo value). More...

TrimDateTime	DateActiveTo `[get]`
	Gets the TrimDateTime property corresponding to when this object first became active. If the returned value is blank, it indicates that the item has always been active (until the DateActiveTo value). More...

string	ActiveDateRangeDescription `[get]`
	Gets a string describing the period during which this object was active. More...

bool	IsActive `[get]`
	Gets a boolean value indicating whether this object is currently active. More...

Detailed Description

The Location object is the second most important object in the Content Manager Object Model. It is used to record the various relationships between people and places and records. There are many types of locations as indicated by the TypeOfLocation enumeration

Constructor & Destructor Documentation

◆ Location() [1/4]

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

◆ Location() [2/4]

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

◆ Location() [3/4]

TRIM.SDK.Location.Location ( Database database )

◆ Location() [4/4]

TRIM.SDK.Location.Location	(	Database	database,
		LocationType	initializeAsType
	)

Member Function Documentation

◆ AddRelationship()

void TRIM.SDK.Location.AddRelationship	(	Location	relatedLocation,
		LocRelationshipType	relationshipType,
		bool	makeThisTheDefaultRelationship
	)

Add a relationship to the location

◆ AddToFavorites()

void TRIM.SDK.Location.AddToFavorites ( )

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

Implements TRIM.SDK.ITrimLabels.

◆ ApplyUserLabel()

void TRIM.SDK.Location.ApplyUserLabel ( UserLabel userLabelToApply )

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

Implements TRIM.SDK.ITrimLabels.

◆ ChangePositionWithinFavorites()

bool TRIM.SDK.Location.ChangePositionWithinFavorites ( LabelPositionChange positionChange )

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

Implements TRIM.SDK.ITrimLabels.

◆ ChangePositionWithinUserLabel()

bool TRIM.SDK.Location.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

Implements TRIM.SDK.ITrimLabels.

◆ Deactivate()

void TRIM.SDK.Location.Deactivate ( )

De-activate removes login permissions for a location, removes any outstanding record requests, removes them from access controls and removes their login user name. This function will automatically commit any changes.

◆ DeleteEx()

void TRIM.SDK.Location.DeleteEx	(	Location	replaceLocationWith,
		bool	removeAnyRequests,
		bool	removeAnyAccessControls,
		bool	copyEmailAddressesToReplacement,
		bool	copyAssociationsToReplacement
	)

An extended version of the Delete function.

◆ DetachUserLabel()

void TRIM.SDK.Location.DetachUserLabel ( UserLabel userLabelToDetach )

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

Implements TRIM.SDK.ITrimLabels.

◆ FindLocationByEmailAddress()

static Location TRIM.SDK.Location.FindLocationByEmailAddress	(	Database	db,
		string	emailAddress
	)

static

A static function to find the most recently added location with a matching internet-style email address.

◆ FindLocationByLDAPDN()

static Location TRIM.SDK.Location.FindLocationByLDAPDN	(	Database	db,
		string	distinguishedName
	)

static

A static function to find a location with the supplied LDAP distinguished name

◆ GetFieldValue()

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

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

Implements TRIM.SDK.ITrimUserFields.

◆ GetFieldValueAsString()

string TRIM.SDK.Location.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.

◆ HasPermission()

bool TRIM.SDK.Location.HasPermission ( UserPermissions checkForPermission )

Flag to indicate whether the permission is valid

◆ HasRelationship()

bool TRIM.SDK.Location.HasRelationship	(	Location	relatedLocation,
		LocRelationshipType	relationshipType
	)

Flag to indicate whether there is a relationship

◆ NewCopy()

Location TRIM.SDK.Location.NewCopy ( )

◆ RemoveAllRelationships()

void TRIM.SDK.Location.RemoveAllRelationships ( )

Remove all relationships

◆ RemoveFromFavorites()

void TRIM.SDK.Location.RemoveFromFavorites ( )

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

Implements TRIM.SDK.ITrimLabels.

◆ RemoveRelationship() [1/2]

void TRIM.SDK.Location.RemoveRelationship ( Location relatedLocation )

Remove all relationships with the specified location

◆ RemoveRelationship() [2/2]

void TRIM.SDK.Location.RemoveRelationship	(	Location	relatedLocation,
		LocRelationshipType	relationshipType
	)

Remove a specific relationship with the specified location

◆ SetActiveDateRange()

void TRIM.SDK.Location.SetActiveDateRange	(	TrimDateTime	validFromDate,
		TrimDateTime	validToDate
	)

Sets the date range for which this object is active. Note that only the date component of the date and time is relevant for active date ranges.

Implements TRIM.SDK.ITrimActiveDates.

◆ SetFieldValue()

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

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

Implements TRIM.SDK.ITrimUserFields.

◆ SetNotes()

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

◆ SetPermission()

void TRIM.SDK.Location.SetPermission	(	UserPermissions	permission,
		bool	turnOn
	)

Set the permission

Property Documentation

◆ AccessControlList

TrimAccessControlList? TRIM.SDK.Location.AccessControlList

getset

◆ ActiveDateRangeDescription

string TRIM.SDK.Location.ActiveDateRangeDescription

get

◆ ActualBarcode

string TRIM.SDK.Location.ActualBarcode

get

Gets a string containing the internal Content Manager Barcode of this Location.

◆ AdditionalLogin

string TRIM.SDK.Location.AdditionalLogin

getset

Gets or sets a string containing the additional Network Login by which this location may log in to the Content Manager Dataset.

◆ Administrator

Location? TRIM.SDK.Location.Administrator

get

Gets the Location for which this Location holds a relationship of type 'Administered By'.

◆ AfterHoursPhoneNumber

string TRIM.SDK.Location.AfterHoursPhoneNumber

getset

Gets or sets a string containing the home number of this Location.

◆ AllAdministrators

string TRIM.SDK.Location.AllAdministrators

get

Gets a string listing all locations that are administrators of this location.

◆ AllMembers

string TRIM.SDK.Location.AllMembers

get

Gets a string listing all locations that are members of this location.

◆ AllMemberships

string TRIM.SDK.Location.AllMemberships

get

Gets a string listing all locations that this location is a member of.

◆ AllMembershipsRecursive

string TRIM.SDK.Location.AllMembershipsRecursive

get

Gets a string listing all locations that this location is a member of, and all locations that those locations are a member of, etc).

◆ BasedOnUserType

UserTypes TRIM.SDK.Location.BasedOnUserType

get

Gets a UserTypes value which determines the underlying user type of this Location (only relevant if the UserType is a custom one).

◆ CanAddToNotes

bool TRIM.SDK.Location.CanAddToNotes

get

◆ CanDeliverDirect

bool TRIM.SDK.Location.CanDeliverDirect

getset

Gets or sets a boolean property indicating whether delivery requests can be handled by direct delivery to the request location, rather than via a transit location

◆ CanLogin

bool TRIM.SDK.Location.CanLogin

getset

Gets or sets a Boolean value indicating whether this Location can log in to the Content Manager Context Dataset.

◆ CanModifyExistingNotes

bool TRIM.SDK.Location.CanModifyExistingNotes

get

◆ CanViewAllDetails

bool TRIM.SDK.Location.CanViewAllDetails

get

Gets a boolean property indicating whether the current user can view all the details of this location.

◆ ChildAddresses

LocationAddresses TRIM.SDK.Location.ChildAddresses

get

Get the list of Physical Addresses

◆ ChildEAddresses

LocationEAddresses TRIM.SDK.Location.ChildEAddresses

get

Get the list of Electronic Addresses

◆ Committee

Location? TRIM.SDK.Location.Committee

get

Gets the Location of Location Type 'Committee' for which this Location holds a relationship of type 'Member Of'. If there is more than one, it returns the Location designated as the default committee. Use the Location.AddRelationship method to create relationships between Locations, through which this property may be set.

◆ CutoffTime

int TRIM.SDK.Location.CutoffTime

getset

Gets or sets the time of day (in seconds past midnight) at which requests are cut-off and must be processed the following day.

◆ DataEntryFormDefinition

string TRIM.SDK.Location.DataEntryFormDefinition

get

Get the xml data entry definition. This will be obsoleted shortly, use the FormDefinition property instead

◆ DateAccessModified

TrimDateTime TRIM.SDK.Location.DateAccessModified

get

Gets a datetime property indicating when the most recent change was made to the security profile, permissions or group membership for this location.

◆ DateActiveFrom

TrimDateTime TRIM.SDK.Location.DateActiveFrom

get

◆ DateActiveTo

TrimDateTime TRIM.SDK.Location.DateActiveTo

get

◆ DateOfBirth

TrimDateTime TRIM.SDK.Location.DateOfBirth

getset

Gets or sets the date of birth of this Location.

◆ DefaultJurisdiction

Jurisdiction? TRIM.SDK.Location.DefaultJurisdiction

getset

Gets or sets the default jurisdiction of this location. A location can either have a default jurisdiction or a default jurisdiction group.

◆ DeliverContainersOnly

bool TRIM.SDK.Location.DeliverContainersOnly

getset

Gets or sets a boolean property indicating whether deliver requests are only support for container records (folders and boxes) rather than individual documents.

◆ DeliveryLocation

Location? TRIM.SDK.Location.DeliveryLocation

get

Gets a location property which represents the location for staging pickup/delivery requests

◆ EmailAddress

string TRIM.SDK.Location.EmailAddress

getset

Gets a string containing the email address of this Location. If there is more than one email address in the Electronic Addresses for this location, the default email address is returned. If there is no default, the latest added email address is returned.

◆ FaxNumber

string TRIM.SDK.Location.FaxNumber

getset

Gets or sets a string containing the fax number of this Location.

◆ FirstInitial

string TRIM.SDK.Location.FirstInitial

get

First initial of this Location.

◆ ForeignBarcode

string TRIM.SDK.Location.ForeignBarcode

getset

Gets or sets a string containing an external system's barcodes for this Location. For multiple barcodes, separate each with a semi-colon. No barcode can be longer than 30 characters.

◆ FormalPreamble

string TRIM.SDK.Location.FormalPreamble

get

Gets a string containing a form of this Location's name to be used in formal correspondence, to complete the salutation: 'Dear ...'. An example formal preamble could be: 'Mr. Abbott', so that the salutation becomes: 'Dear Mr. Abbott'. Note: This property is set automatically by Content Manager. For the title to be included in the formal preamble you must ensure the 'Display any Title' option is checked in Tools - System Options - Locations.

◆ FormattedAddress

string TRIM.SDK.Location.FormattedAddress

get

Gets a string containing the formatted address of this Location. This is by default the postal address of the location if there is one, otherwise the street address. It contains the country name in ISO format.

◆ FormattedName

string TRIM.SDK.Location.FormattedName

get

Gets a string containing the Display Name of this Location. The format of the Display Name is dependent on the system settings for 'Display and Reporting Format for names of People' under Tools - Content Manager Administration - System Options - Locations Tab.

◆ FullFormattedName

string TRIM.SDK.Location.FullFormattedName

get

Gets a string containing the Full Description of this Location. The Full Description consists of the Location's organization and Display Name. The Display Name is contained alone in the property Location.FormattedName

◆ GenderValue

Gender TRIM.SDK.Location.GenderValue

getset

Gets or sets a gnGender enum value indicating the gender of this Location.

◆ GivenNames

string TRIM.SDK.Location.GivenNames

getset

Gets or sets a string containing the given names of this Location.

◆ GpsLocation

string TRIM.SDK.Location.GpsLocation

getset

Gets or sets a geography value representing the GPS reference point for this location

◆ HasAValidLogin

bool TRIM.SDK.Location.HasAValidLogin

get

Gets a boolean property indicating whether this location has a valid login.

◆ HoldingOrganizationName

string TRIM.SDK.Location.HoldingOrganizationName

get

Gets a string representing the name of the holding organization for this location. This is based on the default parent organization if it exists.

◆ HomeDataset

string TRIM.SDK.Location.HomeDataset

getset

Gets or sets a string value indicating, for a visitor login, the id of the dataset that is the home dataset that the visitor normally works with.

◆ Honorific

string TRIM.SDK.Location.Honorific

getset

Gets or sets a string containing the title of this Location (for example, Mr., Ms., Dr. etc).

◆ IdNumber

string TRIM.SDK.Location.IdNumber

getset

Gets or sets a string containing the unique ID number for this Location

◆ InformalPreamble

string TRIM.SDK.Location.InformalPreamble

get

Gets a string containing a form of this Location's name to be used in informal correspondence, to complete the salutation: 'Dear ...'. An example informal preamble could be: 'Peter', so that the salutation becomes: 'Dear Peter'.

◆ Initials

string TRIM.SDK.Location.Initials

getset

Gets or sets a string containing the full set of initials of this Location.

◆ InternetMailAddress

string TRIM.SDK.Location.InternetMailAddress

get

Gets a string containing the email address of this Location which is of email Type 'Internet'. If there is more than one Internet email address in the Electronic Addresses for this location, the default Internet email address is returned. If there is no default, the latest added Internet email address is returned. Create a new LocEAddress child object of EAddress Type 'etEAdressType.etMail' and SubType 'SMTP' to add a new Internet email address for this Location.

◆ IsActive

bool TRIM.SDK.Location.IsActive

get

◆ IsVisitor

bool TRIM.SDK.Location.IsVisitor

getset

Gets or sets a boolean value indicating if this user is a visitor login from the same managed service provider.

◆ IsWithin

bool TRIM.SDK.Location.IsWithin

getset

Gets or sets a Boolean value indicating whether this Location is internal.

◆ JobDescription

string TRIM.SDK.Location.JobDescription

getset

Gets or sets a string containing the Job Title of this Location (for example, Chief Executive Officer).

◆ KeepAddressHistory

bool TRIM.SDK.Location.KeepAddressHistory

getset

Gets or sets a Boolean value indicating whether a history of address changes for this Location should be kept. When the Address History is enabled, modifying an existing LocAddress will cause a new LocAddress child object containing the old address to be automatically created and set to inactive. The LocAddress object that was modified contains the new address and remains active.

◆ LatestLogin

TrimDateTime TRIM.SDK.Location.LatestLogin

get

Gets a datetime value indicating when this location most recently logged in.

◆ LdapSynchDN

string TRIM.SDK.Location.LdapSynchDN

getset

Gets or sets the LDAP Distinguished Name associated with this locations (used for LDAP Synchronization)

◆ LdapSynchEnabled

bool TRIM.SDK.Location.LdapSynchEnabled

getset

Gets or sets a boolean value indicating whether LDAP synchronization is enabled for this location.

◆ LdapSynchLastUpdated

TrimDateTime TRIM.SDK.Location.LdapSynchLastUpdated

getset

Gets or sets a datetime value indicating when this location was last updated by the LDAP Synchronization tool.

◆ LoginDetails

string TRIM.SDK.Location.LoginDetails

get

Gets a string containing the login details for this Location including 'login enabled' status and user type. The format of the string varies according to various circumstances of the location.

◆ LoginExpires

TrimDateTime TRIM.SDK.Location.LoginExpires

getset

Gets or sets the date the login for this Location will expire, if it is a time limited login.

◆ LogsInAs

string TRIM.SDK.Location.LogsInAs

getset

Gets or sets a string containing the Network Login by which this Location may log in to the Content Manager Dataset.

◆ LongHonorific

string TRIM.SDK.Location.LongHonorific

getset

Gets or sets a string containing the longer form of the title of this Location (for example, Mister ).

◆ MobileNumber

string TRIM.SDK.Location.MobileNumber

getset

Gets or sets a string containing the cell/mobile number of this Location.

◆ NickName

string TRIM.SDK.Location.NickName

getset

Gets or sets the string containing the unique name or abbreviation of this Location.

◆ Notes

string TRIM.SDK.Location.Notes

getset

◆ OldPostalAddresses

string TRIM.SDK.Location.OldPostalAddresses

get

Gets a string containing all previous mailing addresses of this location.

◆ OldPostalAddressesISO

string TRIM.SDK.Location.OldPostalAddressesISO

get

Gets a string containing all previous mailing addresses of this location in ISO format.

◆ OldStreetAddresses

string TRIM.SDK.Location.OldStreetAddresses

get

Gets a string containing all previous street addresses of this location.

◆ OldStreetAddressesISO

string TRIM.SDK.Location.OldStreetAddressesISO

get

Gets a string containing all previous street addresses of this location in ISO format.

◆ PermissionsCustomized

bool TRIM.SDK.Location.PermissionsCustomized

get

Gets a boolean property indicating if this user permissions have been customized to be different from a normal user of this type

◆ PhoneNumber

string TRIM.SDK.Location.PhoneNumber

getset

Gets or sets a string containing the main telephone number of this Location. Mobile, fax and home telephone numbers are held in the mobileNo, faxNo and ahPhoneNo properties, respectively.

◆ Position

Location? TRIM.SDK.Location.Position

get

Gets the Location of Location Type 'Position' for which this Location holds a relationship of type 'Member Of'. If there is more than one, it returns the Location designated as the default position. Use the Location.AddRelationship method to create relationships between Locations, through which this property may be set.

◆ PostalAddress

string TRIM.SDK.Location.PostalAddress

get

Gets a string containing the formatted postal address of this location.

◆ PostNominal

string TRIM.SDK.Location.PostNominal

getset

Gets or sets a string containing the suffix of this Location (for example, BA, PhD etc).

◆ ProjectTeam

Location? TRIM.SDK.Location.ProjectTeam

get

Gets the Location of Location Type 'Project Team' for which this Location holds a relationship of type 'Member Of'. If there is more than one, it returns the Location designated as the default project team. Use the Location.AddRelationship method to create relationships between Locations, through which this property may be set.

◆ ProviderContainer

Record? TRIM.SDK.Location.ProviderContainer

getset

Gets or sets a Record Container which will be used when automatically capturing electronic activity log files from storage providers.

◆ ProviderLogRecordType

RecordType? TRIM.SDK.Location.ProviderLogRecordType

getset

Gets or sets a Record Type which will be used when automatically capturing electronic activity log files from storage providers.

◆ RequestResponseHigh

long TRIM.SDK.Location.RequestResponseHigh

getset

Gets or sets the time interval (in seconds) allowed for servicing of high priority requests.

◆ RequestResponseLow

long TRIM.SDK.Location.RequestResponseLow

getset

Gets or sets the time interval (in seconds) allowed for servicing of low priority requests.

◆ RequestResponseMedium

long TRIM.SDK.Location.RequestResponseMedium

getset

Gets or sets the time interval (in seconds) allowed for servicing of medium priority requests.

◆ RequestsNeedApproval

bool TRIM.SDK.Location.RequestsNeedApproval

getset

Gets or sets a boolean property indicating whether requests for records that are located at this location (home) need to be approved by a Request administrator.

◆ ReviewDate

TrimDateTime TRIM.SDK.Location.ReviewDate

getset

Gets the date this Location's settings are due to be reviewed (for example, when a Temporary Staff Member is due to leave the organization).

◆ Salutation

string TRIM.SDK.Location.Salutation

getset

Gets or sets a string containing a custom greeting by which this Location is to be addressed in correspondence. For example:'Dear President'.

◆ SecurityKeys

string TRIM.SDK.Location.SecurityKeys

get

Gets a comma-separated string listing a set of record viewing access keys held by this user.

◆ SecurityProfile

TrimSecurityProfile? TRIM.SDK.Location.SecurityProfile

getset

◆ SecurityString

string TRIM.SDK.Location.SecurityString

getset

Gets or sets a string listing the security level and security caveats assigned to this Location, delimited by commas ','. The first element listed is always the security level, followed by the caveats.

◆ SortName

string TRIM.SDK.Location.SortName

getset

Gets or sets the string containing the sort name of this Location. This is the name that appears in the Locations List Pane.

◆ StreetAddress

string TRIM.SDK.Location.StreetAddress

get

Gets a string containing the formatted street address of this location.

◆ Supervisor

Location? TRIM.SDK.Location.Supervisor

get

Gets the Location for which this Location holds a relationship of type 'Supervised By'. Use the Location.AddRelationship method to create relationships between Locations, through which this property may be set.

◆ Surname

string TRIM.SDK.Location.Surname

getset

Gets or sets a string containing the full surname (including any prefix) of this Location.

◆ SurnameNoPrefix

string TRIM.SDK.Location.SurnameNoPrefix

getset

Gets or sets a string containing the non prefix part of the surname of this Location. For example 'Garderen' is the non prefix part of the full surname 'van Garderen'.

◆ SurnamePrefix

string TRIM.SDK.Location.SurnamePrefix

getset

Gets or sets a string containing the prefix part of the surname of this Location. For example 'van' is the prefix part of the full surname 'van Garderen'.

◆ TypeOfLocation

LocationType TRIM.SDK.Location.TypeOfLocation

getset

Gets or sets the enum value containing the location type of this Location, for example: Person.

◆ Unit

Location? TRIM.SDK.Location.Unit

getset

Gets the Location of Location Type 'organization' for which this Location holds a relationship of type 'Member Of'. If there is more than one, it returns the Location designated as the default organization.

◆ UseAddressOf

Location? TRIM.SDK.Location.UseAddressOf

getset

Gets or sets a pre-existing Location from whom this Location's Street and Mailing Addresses are copied.

◆ UsedForStatistics

bool TRIM.SDK.Location.UsedForStatistics

getset

Gets or sets a boolean value indicating whether this location is to be used for aggregating statistics.

◆ UseProfileOf

Location? TRIM.SDK.Location.UseProfileOf

getset

Gets or sets a pre-existing internal Location from whom this Location's Security and Access Permission Details are copied and set.

◆ UserLicenseType

UserLicenseTypes TRIM.SDK.Location.UserLicenseType

get

Gets ane enumerated value which determines which of the license seat counts is consumed by this user.

◆ UserType

UserTypes TRIM.SDK.Location.UserType

getset

Gets or sets a utUserTypes value which determines the access permissions of this Location.

◆ ViewPaneId

string TRIM.SDK.Location.ViewPaneId

get

Gets a string containing the View Pane ID of this Location. This is used by Content Manager as a key for storing which fields are displayed in the Locations List Window for this Location.

◆ WebPage

string TRIM.SDK.Location.WebPage

getset

Gets a string containing the web page URL of this Location. If there is more than one web page in the Electronic Addresses for this location, the default web page is returned. If there is no default, the latest added web page is returned.

◆ Workgroup

Location? TRIM.SDK.Location.Workgroup

get

Gets the Location of Location Type 'Workgroup' for which this Location holds a relationship of type 'Member Of'. If there is more than one, it returns the Location designated as the default workgroup. Use the Location.AddRelationship method to create relationships between Locations, through which this property may be set.

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Location() [1/4]

◆ Location() [2/4]

◆ Location() [3/4]

◆ Location() [4/4]

Member Function Documentation

◆ AddRelationship()

◆ AddToFavorites()

◆ ApplyUserLabel()

◆ ChangePositionWithinFavorites()

◆ ChangePositionWithinUserLabel()

◆ Deactivate()

◆ DeleteEx()

◆ DetachUserLabel()

◆ FindLocationByEmailAddress()

◆ FindLocationByLDAPDN()

◆ GetFieldValue()

◆ GetFieldValueAsString()

◆ HasPermission()

◆ HasRelationship()

◆ NewCopy()

◆ RemoveAllRelationships()

◆ RemoveFromFavorites()

◆ RemoveRelationship() [1/2]

◆ RemoveRelationship() [2/2]

◆ SetActiveDateRange()

◆ SetFieldValue()

◆ SetNotes()

◆ SetPermission()

Property Documentation

◆ AccessControlList

◆ ActiveDateRangeDescription

◆ ActualBarcode

◆ AdditionalLogin

◆ Administrator

◆ AfterHoursPhoneNumber

◆ AllAdministrators

◆ AllMembers

◆ AllMemberships

◆ AllMembershipsRecursive

◆ BasedOnUserType

◆ CanAddToNotes

◆ CanDeliverDirect

◆ CanLogin

◆ CanModifyExistingNotes

◆ CanViewAllDetails

◆ ChildAddresses

◆ ChildEAddresses

◆ Committee

◆ CutoffTime

◆ DataEntryFormDefinition

◆ DateAccessModified

◆ DateActiveFrom

◆ DateActiveTo

◆ DateOfBirth

◆ DefaultJurisdiction

◆ DeliverContainersOnly

◆ DeliveryLocation

◆ EmailAddress

◆ FaxNumber

◆ FirstInitial

◆ ForeignBarcode

◆ FormalPreamble

◆ FormattedAddress

◆ FormattedName

◆ FullFormattedName

◆ GenderValue

◆ GivenNames

◆ GpsLocation

◆ HasAValidLogin

◆ HoldingOrganizationName

◆ HomeDataset

◆ Honorific

◆ IdNumber

◆ InformalPreamble

◆ Initials