The PropertyOrFieldDef class provides a generic abstraction of TRIM properties and user-defined fields. More...

Inheritance diagram for TRIM.SDK.PropertyOrFieldDef:

Public Member Functions
	PropertyOrFieldDef ()
	Construct a PropertyOrFieldDef that encapsulates a property definition. More...

	PropertyOrFieldDef (PropertyIds propId)
	Construct a PropertyOrFieldDef that encapsulates a property definition. The database parameter allows the item access to any customized captions. More...

	PropertyOrFieldDef (PropertyIds propId, Database forDatabase)
	Construct a PropertyOrFieldDef that encapsulates a property definition. More...

	PropertyOrFieldDef (PropertyDef propDef)
	Construct a PropertyOrFieldDef that encapsulates a FieldDefinition object. More...

	PropertyOrFieldDef (FieldDefinition Field)

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

TrimIcon	GetIconEx (IconUsage forUseAs)
	Gets the TRIMicon associated with this property or field. More...

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

bool	IsSuitableForAggregation (BaseObjectTypes whenSearchingForType)
	Gets a boolean value indicating if the property or field can be used for aggregation More...

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

Static Public Member Functions
static int	Compare (PropertyOrFieldDef itemToTest1, PropertyOrFieldDef itemToTest2)
	Compares two propertyOrFielDef objects, using the caption as a sort sequence More...

static PropertyOrFieldDefList	GetAllPropertiesOrFields (Database withinDatabase, BaseObjectTypes forObjectType)
	Gets an array of PropertyOrFieldDef objects consisting of all properties for the specified object type, followed by all the user defined fields for the specified object type. More...

static PropertyOrFieldDefList	GetAllPropertiesOrFields (TrimObject forObject)
	Gets an array of PropertyOrFieldDef objects consisting of all properties for the specified TrimObject, followed by all the user defined fields for the specified TrimObject. More...

static PropertyOrFieldDefList	GetDataGridPropertiesOrFields (Database withinDatabase, BaseObjectTypes forObjectType)
	Gets an array of PropertyOrFieldDef objects consisting of all suitable data grid properties for the specified object type, followed by all the user defined fields for the specified object type. More...

static PropertyOrFieldDefList	GetDataGridPropertiesOrFields (TrimObject forObject)
	Gets an array of PropertyOrFieldDef objects consisting of all suitable data grid properties for the specified TrimObject, followed by all the user defined fields for the specified TrimObject. More...

static PropertyOrFieldDefList	GetDataGridVisiblePropertiesOrFields (Database withinDatabase, BaseObjectTypes forObjectType)
	Gets an array of PropertyOrFieldDef objects consisting of all suitable data grid properties for the specified object type, followed by all the user defined fields for the specified object type. More...

static PropertyOrFieldDefList	GetDataGridVisiblePropertiesOrFields (TrimObject forObject)
	Gets an array of PropertyOrFieldDef objects consisting of all suitable data grid properties for the specified TrimObject, followed by all the user defined fields for the specified TrimObject. More...

static void	SetDataGridVisiblePropertiesOrFields (TrimObject forObject, PropertyOrFieldDefList propertyAndFieldArray)
	Sets an array of PropertyOrFieldDef objects as the default settings for displaying a set of properties in a grid for the object type. Allows you to persist changes to ordering of columns, size and various data grid properties. More...

static void	SetDataGridVisiblePropertiesOrFields (Database withinDatabase, BaseObjectTypes forObjectType, PropertyOrFieldDefList propertyAndFieldArray)
	Sets an array of PropertyOrFieldDef objects as the default settings for displaying a set of properties in a grid for the object type. Allows you to persist changes to ordering of columns, size and various data grid properties. More...

static PropertyOrFieldDefList	GetDetailedPropertiesOrFields (TrimObject forObject)
	Gets an array of PropertyOrFieldDef objects consisting of the current users selected 'show details' properties and fields for a specific object. These properties and fields typically represent the set of information required by the user when looking at an object in more detail. More...

static void	SetDetailedPropertiesOrFields (TrimObject forObject, PropertyOrFieldDefList propertyAndFieldArray)
	Sets the current users preference for an array of PropertyOrFieldDef objects corresponding to the 'show details' properties and fields for a specific object. These properties and fields typically represent the set of information required by the user when looking at an object in more detail. More...

static PropertyOrFieldDefList	GetMandatoryPropertiesOrFields (TrimObject forObject)
	Gets an array of PropertyOrFieldDef objects consisting of all the 'mandatory' properties of the nominated object. More...

Properties
bool	IsAProperty `[get]`
	Gets a boolean value indicating whether this object represents a property (as opposed to a field). More...

bool	IsAField `[get]`
	Gets a Boolean value indicating whether this object represents a user field (as opposed to a property). More...

PropertyIds	PropertyId `[get]`
	Gets a PropertyIds enumeration value containing the propertyId associated with this object, if it is a property. More...

PropertyDef?	Property `[get]`
	Gets the PropertyDef object associated with this PropertyOrFieldDef, if it is a property. More...

TrimURI	FieldUri `[get]`
	Gets the unique identifier of the FieldDefinition associated with this object, if it is a user field. More...

FieldDefinition?	Field `[get]`
	Gets or sets the FieldDefinition object associated with this PropertyOrFieldDef, it if is a user field More...

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

BaseObjectTypes	ObjectType `[get]`
	Gets a BaseObjectTypes enum value indicating the object type of this property, if PropertyOrFieldDef.PFFormat is 'Object'. More...

string	Caption `[get]`
	Gets the caption corresponding to this property or field. More...

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

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

IconDisplayMode	IconAndOrTextMode `[get, set]`
	Gets or sets the preferred style for displaying an icon when displaying a value for this property More...

bool	BestFitColumn `[get, set]`
	Gets or sets a boolean property indicating whether the a column based on this property should be set to the width of the largest value displayed. too wide to fit into an allocated area. More...

bool	IsDefaultDataGridColumn `[get]`
	Gets or sets a boolean property indicating whether the a column based on this property should be visible. More...

int	ColumnWidth `[get, set]`
	Gets or sets an integer property indicating the display width (in an arbitrary pixel unit) of a column based on this item.whether the a column based on this property. More...

int	DefaultColumnCharacters `[get]`
	Gets an integer property indicating the default number of characters that should be displayed when creating a column based on this property. More...

bool	IsHyperlink `[get]`
	Gets a boolean value indicating if the property or field is a web url hyperlink More...

bool	IsEMailAddress `[get]`
	Gets a boolean value indicating if the property or field is an email address 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 PropertyOrFieldDef class provides a generic abstraction of TRIM properties and user-defined fields.

Constructor & Destructor Documentation

◆ PropertyOrFieldDef() [1/5]

TRIM.SDK.PropertyOrFieldDef.PropertyOrFieldDef ( )

Construct a PropertyOrFieldDef that encapsulates a property definition.

◆ PropertyOrFieldDef() [2/5]

TRIM.SDK.PropertyOrFieldDef.PropertyOrFieldDef ( PropertyIds propId )

Construct a PropertyOrFieldDef that encapsulates a property definition. The database parameter allows the item access to any customized captions.

◆ PropertyOrFieldDef() [3/5]

TRIM.SDK.PropertyOrFieldDef.PropertyOrFieldDef	(	PropertyIds	propId,
		Database	forDatabase
	)

Construct a PropertyOrFieldDef that encapsulates a property definition.

◆ PropertyOrFieldDef() [4/5]

TRIM.SDK.PropertyOrFieldDef.PropertyOrFieldDef ( PropertyDef propDef )

Construct a PropertyOrFieldDef that encapsulates a FieldDefinition object.

◆ PropertyOrFieldDef() [5/5]

TRIM.SDK.PropertyOrFieldDef.PropertyOrFieldDef ( FieldDefinition Field )

Member Function Documentation

◆ Compare()

static int TRIM.SDK.PropertyOrFieldDef.Compare	(	PropertyOrFieldDef	itemToTest1,
		PropertyOrFieldDef	itemToTest2
	)

static

Compares two propertyOrFielDef objects, using the caption as a sort sequence

◆ GetAllPropertiesOrFields() [1/2]

static PropertyOrFieldDefList TRIM.SDK.PropertyOrFieldDef.GetAllPropertiesOrFields	(	Database	withinDatabase,
		BaseObjectTypes	forObjectType
	)

static

Gets an array of PropertyOrFieldDef objects consisting of all properties for the specified object type, followed by all the user defined fields for the specified object type.

◆ GetAllPropertiesOrFields() [2/2]

static PropertyOrFieldDefList TRIM.SDK.PropertyOrFieldDef.GetAllPropertiesOrFields ( TrimObject forObject )

static

Gets an array of PropertyOrFieldDef objects consisting of all properties for the specified TrimObject, followed by all the user defined fields for the specified TrimObject.

◆ GetDataGridPropertiesOrFields() [1/2]

static PropertyOrFieldDefList TRIM.SDK.PropertyOrFieldDef.GetDataGridPropertiesOrFields	(	Database	withinDatabase,
		BaseObjectTypes	forObjectType
	)

static

Gets an array of PropertyOrFieldDef objects consisting of all suitable data grid properties for the specified object type, followed by all the user defined fields for the specified object type.

◆ GetDataGridPropertiesOrFields() [2/2]

static PropertyOrFieldDefList TRIM.SDK.PropertyOrFieldDef.GetDataGridPropertiesOrFields ( TrimObject forObject )

static

Gets an array of PropertyOrFieldDef objects consisting of all suitable data grid properties for the specified TrimObject, followed by all the user defined fields for the specified TrimObject.

◆ GetDataGridVisiblePropertiesOrFields() [1/2]

static PropertyOrFieldDefList TRIM.SDK.PropertyOrFieldDef.GetDataGridVisiblePropertiesOrFields	(	Database	withinDatabase,
		BaseObjectTypes	forObjectType
	)

static

Gets an array of PropertyOrFieldDef objects consisting of all suitable data grid properties for the specified object type, followed by all the user defined fields for the specified object type.

◆ GetDataGridVisiblePropertiesOrFields() [2/2]

static PropertyOrFieldDefList TRIM.SDK.PropertyOrFieldDef.GetDataGridVisiblePropertiesOrFields ( TrimObject forObject )

static

Gets an array of PropertyOrFieldDef objects consisting of all suitable data grid properties for the specified TrimObject, followed by all the user defined fields for the specified TrimObject.

◆ GetDetailedPropertiesOrFields()

static PropertyOrFieldDefList TRIM.SDK.PropertyOrFieldDef.GetDetailedPropertiesOrFields ( TrimObject forObject )

static

Gets an array of PropertyOrFieldDef objects consisting of the current users selected 'show details' properties and fields for a specific object. These properties and fields typically represent the set of information required by the user when looking at an object in more detail.

◆ GetIcon()

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

Gets the identifier of the internal TRIM icon associated with this property or field.

◆ GetIconEx()

TrimIcon TRIM.SDK.PropertyOrFieldDef.GetIconEx ( IconUsage forUseAs )

Gets the TRIMicon associated with this property or field.

◆ GetMandatoryPropertiesOrFields()

static PropertyOrFieldDefList TRIM.SDK.PropertyOrFieldDef.GetMandatoryPropertiesOrFields ( TrimObject forObject )

static

Gets an array of PropertyOrFieldDef objects consisting of all the 'mandatory' properties of the nominated object.

◆ IsMandatory()

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

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

◆ IsSuitableForAggregation()

bool TRIM.SDK.PropertyOrFieldDef.IsSuitableForAggregation ( BaseObjectTypes whenSearchingForType )

Gets a boolean value indicating if the property or field can be used for aggregation

◆ SetDataGridVisiblePropertiesOrFields() [1/2]

static void TRIM.SDK.PropertyOrFieldDef.SetDataGridVisiblePropertiesOrFields	(	Database	withinDatabase,
		BaseObjectTypes	forObjectType,
		PropertyOrFieldDefList	propertyAndFieldArray
	)

static

Sets an array of PropertyOrFieldDef objects as the default settings for displaying a set of properties in a grid for the object type. Allows you to persist changes to ordering of columns, size and various data grid properties.

◆ SetDataGridVisiblePropertiesOrFields() [2/2]

static void TRIM.SDK.PropertyOrFieldDef.SetDataGridVisiblePropertiesOrFields	(	TrimObject	forObject,
		PropertyOrFieldDefList	propertyAndFieldArray
	)

static

Sets an array of PropertyOrFieldDef objects as the default settings for displaying a set of properties in a grid for the object type. Allows you to persist changes to ordering of columns, size and various data grid properties.

◆ SetDetailedPropertiesOrFields()

static void TRIM.SDK.PropertyOrFieldDef.SetDetailedPropertiesOrFields	(	TrimObject	forObject,
		PropertyOrFieldDefList	propertyAndFieldArray
	)

static

Sets the current users preference for an array of PropertyOrFieldDef objects corresponding to the 'show details' properties and fields for a specific object. These properties and fields typically represent the set of information required by the user when looking at an object in more detail.

Property Documentation

◆ BestFitColumn

bool TRIM.SDK.PropertyOrFieldDef.BestFitColumn

getset

Gets or sets a boolean property indicating whether the a column based on this property should be set to the width of the largest value displayed. too wide to fit into an allocated area.

◆ Caption

string TRIM.SDK.PropertyOrFieldDef.Caption

get

Gets the caption corresponding to this property or field.

◆ ColumnWidth

int TRIM.SDK.PropertyOrFieldDef.ColumnWidth

getset

Gets or sets an integer property indicating the display width (in an arbitrary pixel unit) of a column based on this item.whether the a column based on this property.

◆ DefaultColumnCharacters

int TRIM.SDK.PropertyOrFieldDef.DefaultColumnCharacters

get

Gets an integer property indicating the default number of characters that should be displayed when creating a column based on this property.

◆ Field

FieldDefinition? TRIM.SDK.PropertyOrFieldDef.Field

get

Gets or sets the FieldDefinition object associated with this PropertyOrFieldDef, it if is a user field

◆ FieldUri

TrimURI TRIM.SDK.PropertyOrFieldDef.FieldUri

get

Gets the unique identifier of the FieldDefinition associated with this object, if it is a user field.

◆ IconAndOrTextMode

IconDisplayMode TRIM.SDK.PropertyOrFieldDef.IconAndOrTextMode

getset

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

◆ IsAField

bool TRIM.SDK.PropertyOrFieldDef.IsAField

get

Gets a Boolean value indicating whether this object represents a user field (as opposed to a property).

◆ IsAProperty

bool TRIM.SDK.PropertyOrFieldDef.IsAProperty

get

Gets a boolean value indicating whether this object represents a property (as opposed to a field).

◆ IsDefaultDataGridColumn

bool TRIM.SDK.PropertyOrFieldDef.IsDefaultDataGridColumn

get

Gets or sets a boolean property indicating whether the a column based on this property should be visible.

◆ IsEMailAddress

bool TRIM.SDK.PropertyOrFieldDef.IsEMailAddress

get

Gets a boolean value indicating if the property or field is an email address

◆ IsHyperlink

bool TRIM.SDK.PropertyOrFieldDef.IsHyperlink

get

Gets a boolean value indicating if the property or field is a web url hyperlink

◆ ObjectType

BaseObjectTypes TRIM.SDK.PropertyOrFieldDef.ObjectType

get

Gets a BaseObjectTypes enum value indicating the object type of this property, if PropertyOrFieldDef.PFFormat is 'Object'.

◆ PFFormat

PropertyOrFieldFormat TRIM.SDK.PropertyOrFieldDef.PFFormat

get

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

◆ Property

PropertyDef? TRIM.SDK.PropertyOrFieldDef.Property

get

Gets the PropertyDef object associated with this PropertyOrFieldDef, if it is a property.

◆ PropertyId

PropertyIds TRIM.SDK.PropertyOrFieldDef.PropertyId

get

Gets a PropertyIds enumeration value containing the propertyId associated with this object, if it is a property.

◆ SortMode

PropertySortMode TRIM.SDK.PropertyOrFieldDef.SortMode

get

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

◆ StringAlignment

StringDisplayAlignment TRIM.SDK.PropertyOrFieldDef.StringAlignment

getset

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

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PropertyOrFieldDef() [1/5]

◆ PropertyOrFieldDef() [2/5]

◆ PropertyOrFieldDef() [3/5]

◆ PropertyOrFieldDef() [4/5]

◆ PropertyOrFieldDef() [5/5]

Member Function Documentation

◆ Compare()

◆ GetAllPropertiesOrFields() [1/2]

◆ GetAllPropertiesOrFields() [2/2]

◆ GetDataGridPropertiesOrFields() [1/2]

◆ GetDataGridPropertiesOrFields() [2/2]

◆ GetDataGridVisiblePropertiesOrFields() [1/2]

◆ GetDataGridVisiblePropertiesOrFields() [2/2]

◆ GetDetailedPropertiesOrFields()

◆ GetIcon()

◆ GetIconEx()

◆ GetMandatoryPropertiesOrFields()

◆ IsMandatory()

◆ IsSuitableForAggregation()

◆ SetDataGridVisiblePropertiesOrFields() [1/2]

◆ SetDataGridVisiblePropertiesOrFields() [2/2]

◆ SetDetailedPropertiesOrFields()

Property Documentation

◆ BestFitColumn

◆ Caption

◆ ColumnWidth

◆ DefaultColumnCharacters

◆ Field

◆ FieldUri

◆ IconAndOrTextMode

◆ IsAField

◆ IsAProperty

◆ IsDefaultDataGridColumn

◆ IsEMailAddress

◆ IsHyperlink

◆ ObjectType

◆ PFFormat

◆ Property

◆ PropertyId

◆ SortMode

◆ StringAlignment