Inheritance diagram for HP.HPTRIM.SDK.PropertyOrFieldValue:

Public Member Functions
	PropertyOrFieldValue (PropertyIds pid)
	Construct a PropertyOrFieldValue that encapsulates a value for a property definition. More...

	PropertyOrFieldValue (PropertyIds propId, Database forDatabase)
	Construct a PropertyOrFieldValue that encapsulates a value for a property definition. The database parameter allows the item access to any customized captions. More...

	PropertyOrFieldValue (PropertyDef pid)
	construct a property value based on the supplied TRIM property definition More...

	PropertyOrFieldValue (FieldDefinition field)
	Construct a PropertyOrFieldValue that encapsulates a value for a FieldDefinition object. More...

	PropertyOrFieldValue (PropertyOrFieldDef propOrFieldDef)
	Construct a PropertyOrFieldValue that encapsulates a value for a particular property or field definition of a TRIM object. More...

string	GetCurrentValueAsString ()
	Gets a string representation of the current value. More...

string	GetCurrentValueAsString (bool useHTMLescapeCharacters)
	Gets a string representation of the current value. More...

TrimIcon	GetCurrentIcon ()
	Gets the icon associated the current value More...

void	ClearValue ()
	Clears the current value of this property. Will set the modified state to true if the value is actually changed. More...

void	SetValueFromTrim (TrimObject fromTrimObject)
	Sets the current value of this property to be the corresponding property/field of the specified TRIM object. An exception will be thrown if this property/field is not actually a property or field of the supplied TRIM object. Will set the modified state to false. More...

void	SetValueFromTrim (TrimObject fromTrimObject, StringDisplayType propertyValueStringType)
	Sets the current value of this property to be the corresponding property/field of the specified TRIM object. An exception will be thrown if this property/field is not actually a property or field of the supplied TRIM object. Will set the modified state to false. More...

void	ClearModified ()
	Sets the modified state of this value to false. More...

UserFieldValue	GetCurrentValue ()
	Gets an Object representation of the current value - the Object represents the native class used represent this value. More...

void	SetValue (object obj)

void	SetValue (UserFieldValue newValue)
	Sets the current value of this property. Will set the modified state to true if the value is actually changed. More...

void	SetValueFromString (string newValue)
	Sets the current value of this property. Will set the modified state to true if the value is actually changed. More...

Public Member Functions inherited from HP.HPTRIM.SDK.PropertyOrFieldDef
	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 PropertyOrFieldValueList	GetBlankPropertyOrFieldValues (PropertyOrFieldDefList propertyOrFieldSet)
	Constructs an array of blank values, one for each PropertyOrFieldDef in the supplied propertyOrFieldSet. More...

static PropertyOrFieldValueList	GetPropertyOrFieldValues (TrimObject forTrimObject, PropertyOrFieldDefList propertyOrFieldSet)
	Constructs an array of the values of a specified set of properties of a particular object. More...

static PropertyOrFieldValueList	GetPropertyOrFieldValues (TrimObject forTrimObject, PropertyOrFieldDefList propertyOrFieldSet, StringDisplayType stringType)
	Constructs an array of the values of a specified set of properties of a particular object. The string display type parameter is used to indicate what type of string value to retrieve. More...

static int	Compare (PropertyOrFieldValue propertyOrFieldValue1, PropertyOrFieldValue propertyOrFieldValue2)
	Compares two PropertyOrFieldValue values to see which should appear first in a sort sequence. Generally assumed that both PropertyOrFieldValue values would be based on the same PropertyorFieldDef. Returns -1 to indicate that propertyOrFieldValue1 is less than propertyOrFieldValue1, 0 to indicate that the propertyOrFieldValues are equal +1 to indicate that propertyOrFieldValue1 is greater than propertyOrFieldValue1, More...

Static Public Member Functions inherited from HP.HPTRIM.SDK.PropertyOrFieldDef
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	IsModified `[get]`
	The modified state tracks any changes made to this property value by the various set functions. More...

Properties inherited from HP.HPTRIM.SDK.PropertyOrFieldDef
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.PropertyOrFieldValue.PropertyOrFieldValue ( PropertyIds pid )

Construct a PropertyOrFieldValue that encapsulates a value for a property definition.

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

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

HP.HPTRIM.SDK.PropertyOrFieldValue.PropertyOrFieldValue ( PropertyDef pid )

construct a property value based on the supplied TRIM property definition

HP.HPTRIM.SDK.PropertyOrFieldValue.PropertyOrFieldValue ( FieldDefinition field )

Construct a PropertyOrFieldValue that encapsulates a value for a FieldDefinition object.

HP.HPTRIM.SDK.PropertyOrFieldValue.PropertyOrFieldValue ( PropertyOrFieldDef propOrFieldDef )

Construct a PropertyOrFieldValue that encapsulates a value for a particular property or field definition of a TRIM object.

Member Function Documentation

void HP.HPTRIM.SDK.PropertyOrFieldValue.ClearModified ( )

Sets the modified state of this value to false.

void HP.HPTRIM.SDK.PropertyOrFieldValue.ClearValue ( )

Clears the current value of this property. Will set the modified state to true if the value is actually changed.

static int HP.HPTRIM.SDK.PropertyOrFieldValue.Compare	(	PropertyOrFieldValue	propertyOrFieldValue1,
		PropertyOrFieldValue	propertyOrFieldValue2
	)

static

Compares two PropertyOrFieldValue values to see which should appear first in a sort sequence. Generally assumed that both PropertyOrFieldValue values would be based on the same PropertyorFieldDef. Returns -1 to indicate that propertyOrFieldValue1 is less than propertyOrFieldValue1, 0 to indicate that the propertyOrFieldValues are equal +1 to indicate that propertyOrFieldValue1 is greater than propertyOrFieldValue1,

static PropertyOrFieldValueList HP.HPTRIM.SDK.PropertyOrFieldValue.GetBlankPropertyOrFieldValues ( PropertyOrFieldDefList propertyOrFieldSet )

static

Constructs an array of blank values, one for each PropertyOrFieldDef in the supplied propertyOrFieldSet.

TrimIcon HP.HPTRIM.SDK.PropertyOrFieldValue.GetCurrentIcon ( )

Gets the icon associated the current value

UserFieldValue HP.HPTRIM.SDK.PropertyOrFieldValue.GetCurrentValue ( )

Gets an Object representation of the current value - the Object represents the native class used represent this value.

string HP.HPTRIM.SDK.PropertyOrFieldValue.GetCurrentValueAsString ( )

Gets a string representation of the current value.

string HP.HPTRIM.SDK.PropertyOrFieldValue.GetCurrentValueAsString ( bool useHTMLescapeCharacters )

Gets a string representation of the current value.

static PropertyOrFieldValueList HP.HPTRIM.SDK.PropertyOrFieldValue.GetPropertyOrFieldValues	(	TrimObject	forTrimObject,
		PropertyOrFieldDefList	propertyOrFieldSet
	)

static

Constructs an array of the values of a specified set of properties of a particular object.

static PropertyOrFieldValueList HP.HPTRIM.SDK.PropertyOrFieldValue.GetPropertyOrFieldValues	(	TrimObject	forTrimObject,
		PropertyOrFieldDefList	propertyOrFieldSet,
		StringDisplayType	stringType
	)

static

Constructs an array of the values of a specified set of properties of a particular object. The string display type parameter is used to indicate what type of string value to retrieve.

void HP.HPTRIM.SDK.PropertyOrFieldValue.SetValue ( object obj )

void HP.HPTRIM.SDK.PropertyOrFieldValue.SetValue ( UserFieldValue newValue )

Sets the current value of this property. Will set the modified state to true if the value is actually changed.

void HP.HPTRIM.SDK.PropertyOrFieldValue.SetValueFromString ( string newValue )

Sets the current value of this property. Will set the modified state to true if the value is actually changed.

void HP.HPTRIM.SDK.PropertyOrFieldValue.SetValueFromTrim ( TrimObject fromTrimObject )

Sets the current value of this property to be the corresponding property/field of the specified TRIM object. An exception will be thrown if this property/field is not actually a property or field of the supplied TRIM object. Will set the modified state to false.

void HP.HPTRIM.SDK.PropertyOrFieldValue.SetValueFromTrim	(	TrimObject	fromTrimObject,
		StringDisplayType	propertyValueStringType
	)

Sets the current value of this property to be the corresponding property/field of the specified TRIM object. An exception will be thrown if this property/field is not actually a property or field of the supplied TRIM object. Will set the modified state to false.

Property Documentation

bool HP.HPTRIM.SDK.PropertyOrFieldValue.IsModified

get

The modified state tracks any changes made to this property value by the various set functions.

Public Member Functions

Static Public Member Functions

Properties

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation