Micro Focus Content Manager SDK 9.3
HP.HPTRIM.SDK.PropertyOrFieldDef Class Reference
Inheritance diagram for HP.HPTRIM.SDK.PropertyOrFieldDef:
HP.HPTRIM.SDK.TrimSDKObject HP.HPTRIM.SDK.PropertyOrFieldValue

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 TRIM icon 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...
 
- Public Member Functions inherited from HP.HPTRIM.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 HP.HPTRIM.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...
 

Constructor & Destructor Documentation

HP.HPTRIM.SDK.PropertyOrFieldDef.PropertyOrFieldDef ( )

Construct a PropertyOrFieldDef that encapsulates a property definition.

HP.HPTRIM.SDK.PropertyOrFieldDef.PropertyOrFieldDef ( PropertyIds  propId)

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

HP.HPTRIM.SDK.PropertyOrFieldDef.PropertyOrFieldDef ( PropertyIds  propId,
Database  forDatabase 
)

Construct a PropertyOrFieldDef that encapsulates a property definition.

HP.HPTRIM.SDK.PropertyOrFieldDef.PropertyOrFieldDef ( PropertyDef  propDef)

Construct a PropertyOrFieldDef that encapsulates a FieldDefinition object.

HP.HPTRIM.SDK.PropertyOrFieldDef.PropertyOrFieldDef ( FieldDefinition  Field)

Member Function Documentation

static int HP.HPTRIM.SDK.PropertyOrFieldDef.Compare ( PropertyOrFieldDef  itemToTest1,
PropertyOrFieldDef  itemToTest2 
)
static

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

static PropertyOrFieldDefList HP.HPTRIM.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.

static PropertyOrFieldDefList HP.HPTRIM.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.

static PropertyOrFieldDefList HP.HPTRIM.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.

static PropertyOrFieldDefList HP.HPTRIM.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.

static PropertyOrFieldDefList HP.HPTRIM.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.

static PropertyOrFieldDefList HP.HPTRIM.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.

static PropertyOrFieldDefList HP.HPTRIM.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.

Icons HP.HPTRIM.SDK.PropertyOrFieldDef.GetIcon ( IconUsage  forUseAs)

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

static PropertyOrFieldDefList HP.HPTRIM.SDK.PropertyOrFieldDef.GetMandatoryPropertiesOrFields ( TrimObject  forObject)
static

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

bool HP.HPTRIM.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.

static void HP.HPTRIM.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.

static void HP.HPTRIM.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.

static void HP.HPTRIM.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

bool HP.HPTRIM.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.

string HP.HPTRIM.SDK.PropertyOrFieldDef.Caption
get

Gets the caption corresponding to this property or field.

int HP.HPTRIM.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.

int HP.HPTRIM.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.

FieldDefinition HP.HPTRIM.SDK.PropertyOrFieldDef.Field
get

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

TrimURI HP.HPTRIM.SDK.PropertyOrFieldDef.FieldUri
get

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

IconDisplayMode HP.HPTRIM.SDK.PropertyOrFieldDef.IconAndOrTextMode
getset

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

bool HP.HPTRIM.SDK.PropertyOrFieldDef.IsAField
get

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

bool HP.HPTRIM.SDK.PropertyOrFieldDef.IsAProperty
get

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

bool HP.HPTRIM.SDK.PropertyOrFieldDef.IsDefaultDataGridColumn
get

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

bool HP.HPTRIM.SDK.PropertyOrFieldDef.IsEMailAddress
get

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

bool HP.HPTRIM.SDK.PropertyOrFieldDef.IsHyperlink
get

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

BaseObjectTypes HP.HPTRIM.SDK.PropertyOrFieldDef.ObjectType
get

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

PropertyOrFieldFormat HP.HPTRIM.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.

PropertyDef HP.HPTRIM.SDK.PropertyOrFieldDef.Property
get

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

PropertyIds HP.HPTRIM.SDK.PropertyOrFieldDef.PropertyId
get

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

PropertySortMode HP.HPTRIM.SDK.PropertyOrFieldDef.SortMode
get

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

StringDisplayAlignment HP.HPTRIM.SDK.PropertyOrFieldDef.StringAlignment
getset

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