The PropertyDef class provides a generic abstraction of TRIM properties. More...

Inheritance diagram for TRIM.SDK.PropertyDef:

Public Member Functions
	PropertyDef ()

	PropertyDef (PropertyIds pid)

	PropertyDef (PropertyIds pid, Database withinDB)

Icons	GetIcon (IconUsage forUseAs)
	Gets the identifier of the TRIM icon associated with this property. More...

bool	BelongsTo (BaseObjectTypes type)
	Gets a BaseObjectTypes enum value indicating what type of TRIM object this property belongs to. More...

SearchClauseIds	GetSortClauseId (BaseObjectTypes forListsOfObjectType, bool strict)
	This returns the same as the SearchClauseId property, provided the search clause is sortable. The strict parameter will also exclude and search clause that does not perform a strictly alphabetic sort, such as properties that are enums or objects) More...

bool	IsMandatory (TrimObject forObject)
	Gets a boolean value indicating if the property is mandatory (cannot have an empty/null value) for the supplied TRIM object. More...

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

Static Public Member Functions
static PropertyDef	FindUsingInternalName (string internalPropertyName)
	Find a property definition based on the supplied internal name. More...

static PropertyDef	FindUsingInternalName (string internalPropertyName, Database forDatabase)
	Find a property definition based on the supplied internal name. Providing the database object ensures that the returned property definition has access to any customized captions within that database. More...

static PropertyDefList	GetAllProperties (BaseObjectTypes forObjectType)
	Constructs an array of all property definitions for the nominated object type. More...

static PropertyDefList	GetAllProperties (BaseObjectTypes forObjectType, Database forDatabase)
	Constructs an array of all property definitions for the nominated object type. Providing the database object ensures that the returned property definition has access to any customized captions within that database. More...

static PropertyDefList	GetAllProperties (UserOptionSetIds forOptionSet)
	Constructs an array of all property definitions for the nominated user option set. More...

static PropertyDefList	GetAllProperties (UserOptionSetIds forOptionSet, Database forDatabase)
	Constructs an array of all property definitions for the nominated nominated user option set. Providing the database object ensures that the returned property definition has access to any customized captions within that database. More...

static PropertyDefList	GetViewPaneProperties (BaseObjectTypes forObjectType)
	Constructs an array of all view pane property definitions of the nominated object type. More...

static PropertyDefList	GetViewPaneProperties (BaseObjectTypes forObjectType, Database forDatabase)
	Constructs an array of all view pane property definitions of the nominated object type. Providing the database object ensures that the returned property definitions have access to any customized captions within that database. More...

static PropertyDefList	GetDataGridProperties (BaseObjectTypes forObjectType)
	Constructs an array of all property definitions that are suitable data grid columns of the nominated object type. More...

static PropertyDefList	GetDataGridProperties (BaseObjectTypes forObjectType, Database forDatabase)
	Constructs an array of all property definitions that are suitable data grid columns of the nominated object type. Providing the database object ensures that the returned property definitions have access to any customized captions within that database. More...

static PropertyDefList	GetWriteableProperties (BaseObjectTypes forObjectType)
	Constructs an array of all writable property definitions of the nominated object type. More...

static PropertyDefList	GetWriteableProperties (BaseObjectTypes forObjectType, Database forDatabase)
	Constructs an array of all writable property definitions of the nominated object type. Providing the database object ensures that the returned property definitions have access to any customized captions within that database. More...

static PropertyDefList	GetSearchOptionProperties (BaseObjectTypes whenSearchingForObject, Database forDatabase)
	Constructs an array of all property definitions that belong to the UserSearchOptions option set and that are also relevant for use when searching for the specified type of object. More...

Properties
PropertyIds	Id `[get]`
	Gets an integer containing the unique property identifier for this property definition. More...

string	Caption `[get, set]`
	Gets or sets a string containing the descriptive caption for this property. Note that to set a caption, this property must have been constructed with a valid Database parameter. To make caption changes permanent, call the SaveCaptionChanges() method of the database. More...

string	CaptionShort `[get, set]`
	Gets or sets a string containing the abbreviated caption for this property. Note that to set a caption, this property must have been constructed with a valid Database parameter. To make caption changes permanent, call the SaveCaptionChanges() method of the database. More...

PropertySortMode	SortMode `[get]`
	Gets the sorting mode most suited to the values of this property. More...

StringDisplayAlignment	StringAlignment `[get]`
	Gets the preferred method for aligning a string when displaying values of this property. More...

IconDisplayMode	IconDefaultMode `[get]`
	Gets the preferred style for displaying an icon when displaying a value for this property More...

bool	IsReadOnly `[get]`
	Gets a Boolean value indicating whether this Property Definition is read only or not. More...

bool	IsOkForViewPane `[get]`
	Gets a Boolean value indicating whether this Property can be displayed in the ViewPane More...

bool	IsDefaultForViewPane `[get]`
	Gets a Boolean value indicating whether this Property is displayed in the ViewPane by default. More...

bool	IsOkForDataEntry `[get]`
	Gets a Boolean value indicating whether this Property can be displayed on the Data Entry Form for this object. More...

PropertyFormats	Format `[get]`
	Gets a pfPropertyFormats enum value indicating the data type (format) of this Property. If the property is an object data type ('pfObject'), the TRIM Object type is held in the 'ObjectType' property. If it is an enumerated type ('pfEnum'), the TRIM Enumeration type is held in the 'EnumType' property. More...

BaseObjectTypes	ObjectType `[get]`
	Gets a BaseObjectTypes enum value indicating the object type of this property, if it is of PropertyDef.Format 'pfObject'. More...

AllEnumerations	EnumType `[get]`
	Gets an enmAllEnumerations enum value indicating the enumerator type of this property, if it is of PropertyDef.Format 'pfEnum'. More...

bool	IsNameProperty `[get]`
	Gets a Boolean value indicating whether this property is the default 'unique naming' property for the object, by which it may be instantiated instead of by uri. More...

string	InternalName `[get]`
	Gets a string containing the internal name for this property. More...

bool	IsExposedInSDK `[get]`
	Gets a Boolean value indicating whether this property is directly exposed for use in the SDK. More...

PropertyOrFieldFormat	PFFormat `[get]`
	Gets a poPropertyOrFieldFormat enum value indicating the generic format of this property in the context of formats available to TRIM Properties or Fields. More...

int	Length `[get]`
	Gets the length of this property if it is a string More...

string	TrueString `[get]`
	Gets the string representing true for a property of type boolean. Most likely this will be 'True', but for some boolean properties, it may contain something more descriptive. For example, the property 'IsActive' may have a true string of 'Active' and a false string of 'InActive' More...

string	FalseString `[get]`
	Gets the string representing false for a property of type boolean. Most likely this will be 'False', but for some boolean properties, it may contain something more descriptive. For example, the property 'IsActive' may have a true string of 'Active' and a false string of 'Inactive'. More...

bool	IsDataGridColumn `[get]`
	Gets a Boolean value indicating whether this Property would be useful displayed in a data grid. More...

bool	IsDefaultDataGridColumn `[get]`
	Gets a Boolean value indicating whether this Property should be displayed as a default column in a data grid. More...

SearchClauseIds	SearchClauseId `[get]`
	Gets a SearchClauseIds value indicating whether this property can be used for searches. Returns Unknown if it is not suitable. More...

bool	CanView `[get]`
	Gets a Boolean value indicating whether the current user has the permission to view this property. Some system settings such as classified security, DoD 5015.3 compliance, require properties to be hidden. More...

Properties inherited from TRIM.SDK.TrimSDKObject
string	ErrorMessage `[get]`
	All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...

TrimException	Error `[get]`
	All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...

Detailed Description

The PropertyDef class provides a generic abstraction of TRIM properties.

Constructor & Destructor Documentation

◆ PropertyDef() [1/3]

TRIM.SDK.PropertyDef.PropertyDef ( )

◆ PropertyDef() [2/3]

TRIM.SDK.PropertyDef.PropertyDef ( PropertyIds pid )

◆ PropertyDef() [3/3]

TRIM.SDK.PropertyDef.PropertyDef	(	PropertyIds	pid,
		Database	withinDB
	)

Member Function Documentation

◆ BelongsTo()

bool TRIM.SDK.PropertyDef.BelongsTo ( BaseObjectTypes type )

Gets a BaseObjectTypes enum value indicating what type of TRIM object this property belongs to.

◆ FindUsingInternalName() [1/2]

static PropertyDef TRIM.SDK.PropertyDef.FindUsingInternalName ( string internalPropertyName )

static

Find a property definition based on the supplied internal name.

◆ FindUsingInternalName() [2/2]

static PropertyDef TRIM.SDK.PropertyDef.FindUsingInternalName	(	string	internalPropertyName,
		Database	forDatabase
	)

static

Find a property definition based on the supplied internal name. Providing the database object ensures that the returned property definition has access to any customized captions within that database.

◆ GetAllProperties() [1/4]

static PropertyDefList TRIM.SDK.PropertyDef.GetAllProperties ( BaseObjectTypes forObjectType )

static

Constructs an array of all property definitions for the nominated object type.

◆ GetAllProperties() [2/4]

static PropertyDefList TRIM.SDK.PropertyDef.GetAllProperties	(	BaseObjectTypes	forObjectType,
		Database	forDatabase
	)

static

Constructs an array of all property definitions for the nominated object type. Providing the database object ensures that the returned property definition has access to any customized captions within that database.

◆ GetAllProperties() [3/4]

static PropertyDefList TRIM.SDK.PropertyDef.GetAllProperties ( UserOptionSetIds forOptionSet )

static

Constructs an array of all property definitions for the nominated user option set.

◆ GetAllProperties() [4/4]

static PropertyDefList TRIM.SDK.PropertyDef.GetAllProperties	(	UserOptionSetIds	forOptionSet,
		Database	forDatabase
	)

static

Constructs an array of all property definitions for the nominated nominated user option set. Providing the database object ensures that the returned property definition has access to any customized captions within that database.

◆ GetDataGridProperties() [1/2]

static PropertyDefList TRIM.SDK.PropertyDef.GetDataGridProperties ( BaseObjectTypes forObjectType )

static

Constructs an array of all property definitions that are suitable data grid columns of the nominated object type.

◆ GetDataGridProperties() [2/2]

static PropertyDefList TRIM.SDK.PropertyDef.GetDataGridProperties	(	BaseObjectTypes	forObjectType,
		Database	forDatabase
	)

static

Constructs an array of all property definitions that are suitable data grid columns of the nominated object type. Providing the database object ensures that the returned property definitions have access to any customized captions within that database.

◆ GetIcon()

Icons TRIM.SDK.PropertyDef.GetIcon ( IconUsage forUseAs )

Gets the identifier of the TRIM icon associated with this property.

◆ GetSearchOptionProperties()

static PropertyDefList TRIM.SDK.PropertyDef.GetSearchOptionProperties	(	BaseObjectTypes	whenSearchingForObject,
		Database	forDatabase
	)

static

Constructs an array of all property definitions that belong to the UserSearchOptions option set and that are also relevant for use when searching for the specified type of object.

◆ GetSortClauseId()

SearchClauseIds TRIM.SDK.PropertyDef.GetSortClauseId	(	BaseObjectTypes	forListsOfObjectType,
		bool	strict
	)

This returns the same as the SearchClauseId property, provided the search clause is sortable. The strict parameter will also exclude and search clause that does not perform a strictly alphabetic sort, such as properties that are enums or objects)

◆ GetViewPaneProperties() [1/2]

static PropertyDefList TRIM.SDK.PropertyDef.GetViewPaneProperties ( BaseObjectTypes forObjectType )

static

Constructs an array of all view pane property definitions of the nominated object type.

◆ GetViewPaneProperties() [2/2]

static PropertyDefList TRIM.SDK.PropertyDef.GetViewPaneProperties	(	BaseObjectTypes	forObjectType,
		Database	forDatabase
	)

static

Constructs an array of all view pane property definitions of the nominated object type. Providing the database object ensures that the returned property definitions have access to any customized captions within that database.

◆ GetWriteableProperties() [1/2]

static PropertyDefList TRIM.SDK.PropertyDef.GetWriteableProperties ( BaseObjectTypes forObjectType )

static

Constructs an array of all writable property definitions of the nominated object type.

◆ GetWriteableProperties() [2/2]

static PropertyDefList TRIM.SDK.PropertyDef.GetWriteableProperties	(	BaseObjectTypes	forObjectType,
		Database	forDatabase
	)

static

Constructs an array of all writable property definitions of the nominated object type. Providing the database object ensures that the returned property definitions have access to any customized captions within that database.

◆ IsMandatory()

bool TRIM.SDK.PropertyDef.IsMandatory ( TrimObject forObject )

Gets a boolean value indicating if the property is mandatory (cannot have an empty/null value) for the supplied TRIM object.

Property Documentation

◆ CanView

bool TRIM.SDK.PropertyDef.CanView

get

Gets a Boolean value indicating whether the current user has the permission to view this property. Some system settings such as classified security, DoD 5015.3 compliance, require properties to be hidden.

◆ Caption

string TRIM.SDK.PropertyDef.Caption

getset

Gets or sets a string containing the descriptive caption for this property. Note that to set a caption, this property must have been constructed with a valid Database parameter. To make caption changes permanent, call the SaveCaptionChanges() method of the database.

◆ CaptionShort

string TRIM.SDK.PropertyDef.CaptionShort

getset

Gets or sets a string containing the abbreviated caption for this property. Note that to set a caption, this property must have been constructed with a valid Database parameter. To make caption changes permanent, call the SaveCaptionChanges() method of the database.

◆ EnumType

AllEnumerations TRIM.SDK.PropertyDef.EnumType

get

Gets an enmAllEnumerations enum value indicating the enumerator type of this property, if it is of PropertyDef.Format 'pfEnum'.

◆ FalseString

string TRIM.SDK.PropertyDef.FalseString

get

Gets the string representing false for a property of type boolean. Most likely this will be 'False', but for some boolean properties, it may contain something more descriptive. For example, the property 'IsActive' may have a true string of 'Active' and a false string of 'Inactive'.

◆ Format

PropertyFormats TRIM.SDK.PropertyDef.Format

get

Gets a pfPropertyFormats enum value indicating the data type (format) of this Property. If the property is an object data type ('pfObject'), the TRIM Object type is held in the 'ObjectType' property. If it is an enumerated type ('pfEnum'), the TRIM Enumeration type is held in the 'EnumType' property.

◆ IconDefaultMode

IconDisplayMode TRIM.SDK.PropertyDef.IconDefaultMode

get

Gets the preferred style for displaying an icon when displaying a value for this property

◆ Id

PropertyIds TRIM.SDK.PropertyDef.Id

get

Gets an integer containing the unique property identifier for this property definition.

◆ InternalName

string TRIM.SDK.PropertyDef.InternalName

get

Gets a string containing the internal name for this property.

◆ IsDataGridColumn

bool TRIM.SDK.PropertyDef.IsDataGridColumn

get

Gets a Boolean value indicating whether this Property would be useful displayed in a data grid.

◆ IsDefaultDataGridColumn

bool TRIM.SDK.PropertyDef.IsDefaultDataGridColumn

get

Gets a Boolean value indicating whether this Property should be displayed as a default column in a data grid.

◆ IsDefaultForViewPane

bool TRIM.SDK.PropertyDef.IsDefaultForViewPane

get

Gets a Boolean value indicating whether this Property is displayed in the ViewPane by default.

◆ IsExposedInSDK

bool TRIM.SDK.PropertyDef.IsExposedInSDK

get

Gets a Boolean value indicating whether this property is directly exposed for use in the SDK.

◆ IsNameProperty

bool TRIM.SDK.PropertyDef.IsNameProperty

get

Gets a Boolean value indicating whether this property is the default 'unique naming' property for the object, by which it may be instantiated instead of by uri.

◆ IsOkForDataEntry

bool TRIM.SDK.PropertyDef.IsOkForDataEntry

get

Gets a Boolean value indicating whether this Property can be displayed on the Data Entry Form for this object.

◆ IsOkForViewPane

bool TRIM.SDK.PropertyDef.IsOkForViewPane

get

Gets a Boolean value indicating whether this Property can be displayed in the ViewPane

◆ IsReadOnly

bool TRIM.SDK.PropertyDef.IsReadOnly

get

Gets a Boolean value indicating whether this Property Definition is read only or not.

◆ Length

int TRIM.SDK.PropertyDef.Length

get

Gets the length of this property if it is a string

◆ ObjectType

BaseObjectTypes TRIM.SDK.PropertyDef.ObjectType

get

Gets a BaseObjectTypes enum value indicating the object type of this property, if it is of PropertyDef.Format 'pfObject'.

◆ PFFormat

PropertyOrFieldFormat TRIM.SDK.PropertyDef.PFFormat

get

Gets a poPropertyOrFieldFormat enum value indicating the generic format of this property in the context of formats available to TRIM Properties or Fields.

◆ SearchClauseId

SearchClauseIds TRIM.SDK.PropertyDef.SearchClauseId

get

Gets a SearchClauseIds value indicating whether this property can be used for searches. Returns Unknown if it is not suitable.

◆ SortMode

PropertySortMode TRIM.SDK.PropertyDef.SortMode

get

Gets the sorting mode most suited to the values of this property.

◆ StringAlignment

StringDisplayAlignment TRIM.SDK.PropertyDef.StringAlignment

get

Gets the preferred method for aligning a string when displaying values of this property.

◆ TrueString

string TRIM.SDK.PropertyDef.TrueString

get

Gets the string representing true for a property of type boolean. Most likely this will be 'True', but for some boolean properties, it may contain something more descriptive. For example, the property 'IsActive' may have a true string of 'Active' and a false string of 'InActive'

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PropertyDef() [1/3]

◆ PropertyDef() [2/3]

◆ PropertyDef() [3/3]

Member Function Documentation

◆ BelongsTo()

◆ FindUsingInternalName() [1/2]

◆ FindUsingInternalName() [2/2]

◆ GetAllProperties() [1/4]

◆ GetAllProperties() [2/4]

◆ GetAllProperties() [3/4]

◆ GetAllProperties() [4/4]

◆ GetDataGridProperties() [1/2]

◆ GetDataGridProperties() [2/2]

◆ GetIcon()

◆ GetSearchOptionProperties()

◆ GetSortClauseId()

◆ GetViewPaneProperties() [1/2]

◆ GetViewPaneProperties() [2/2]

◆ GetWriteableProperties() [1/2]

◆ GetWriteableProperties() [2/2]

◆ IsMandatory()

Property Documentation

◆ CanView

◆ Caption

◆ CaptionShort

◆ EnumType

◆ FalseString

◆ Format

◆ IconDefaultMode

◆ Id

◆ InternalName

◆ IsDataGridColumn

◆ IsDefaultDataGridColumn

◆ IsDefaultForViewPane

◆ IsExposedInSDK

◆ IsNameProperty

◆ IsOkForDataEntry

◆ IsOkForViewPane

◆ IsReadOnly

◆ Length

◆ ObjectType

◆ PFFormat

◆ SearchClauseId

◆ SortMode

◆ StringAlignment

◆ TrueString