HP.HPTRIM.SDK.TrimPropertySet Class Reference

Inheritance diagram for HP.HPTRIM.SDK.TrimPropertySet:

Public Member Functions
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...

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

Member Function Documentation

bool HP.HPTRIM.SDK.TrimPropertySet.CanModifyProperty

(

PropertyIds

propertyId

)

Indicates whether the current user has the permission to modify the specified property.

bool HP.HPTRIM.SDK.TrimPropertySet.ClearProperty

(

PropertyIds

dnPropId

)

object HP.HPTRIM.SDK.TrimPropertySet.GetProperty

(

PropertyIds

propId

)

Each TRIM object has one or more properties. These properties have been abstracted, and each one allocated a unique property id. This allows general purpose controls, etc, to access property values in a generic way, without the need for reflection. This method returns the value of a property as a generic object. Depending on the Format of the property, the Object may be an Int or a TRIMdateTime etc.

string HP.HPTRIM.SDK.TrimPropertySet.GetPropertyAsString	(	PropertyIds	propertyId,
		StringDisplayType	propertyValueStringType,
		bool	useHTMLEscapeChars
	)

Gets a string representation of a property value in a format appropriate for a specific use.

bool HP.HPTRIM.SDK.TrimPropertySet.GetPropertyBool

(

PropertyIds

dnPropId

)

TrimCurrency HP.HPTRIM.SDK.TrimPropertySet.GetPropertyCurrency

(

PropertyIds

dnPropId

)

TrimDateTime HP.HPTRIM.SDK.TrimPropertySet.GetPropertyDate

(

PropertyIds

dnPropId

)

TrimDecimal HP.HPTRIM.SDK.TrimPropertySet.GetPropertyDecimal

(

PropertyIds

dnPropId

)

TrimIcon HP.HPTRIM.SDK.TrimPropertySet.GetPropertyIcon

(

PropertyIds

propertyId

)

Gets the icon value associated the a property of this object.

int HP.HPTRIM.SDK.TrimPropertySet.GetPropertyLong

(

PropertyIds

dnPropId

)

long HP.HPTRIM.SDK.TrimPropertySet.GetPropertyLong64

(

PropertyIds

dnPropId

)

string HP.HPTRIM.SDK.TrimPropertySet.GetPropertyString

(

PropertyIds

dnPropId

)

TrimMainObject HP.HPTRIM.SDK.TrimPropertySet.GetPropertyTrimObject

(

PropertyIds

dnPropId

)

TrimURI HP.HPTRIM.SDK.TrimPropertySet.GetPropertyUri

(

PropertyIds

dnPropId

)

bool HP.HPTRIM.SDK.TrimPropertySet.IsMandatory

(

PropertyIds

propertyId

)

Gets a boolean value indication whether the specified property must have a non-NULL value for this object.

bool HP.HPTRIM.SDK.TrimPropertySet.SetProperty	(	PropertyIds	propId,
		object	newValue
	)

bool HP.HPTRIM.SDK.TrimPropertySet.SetPropertyBool	(	PropertyIds	dnPropId,
		bool	newValue
	)

bool HP.HPTRIM.SDK.TrimPropertySet.SetPropertyCurrency	(	PropertyIds	dnPropId,
		TrimCurrency	newValue
	)

bool HP.HPTRIM.SDK.TrimPropertySet.SetPropertyDate	(	PropertyIds	dnPropId,
		TrimDateTime	newValue
	)

bool HP.HPTRIM.SDK.TrimPropertySet.SetPropertyDecimal	(	PropertyIds	dnPropId,
		TrimDecimal	newValue
	)

bool HP.HPTRIM.SDK.TrimPropertySet.SetPropertyDouble	(	PropertyIds	dnPropId,
		double	newValue
	)

bool HP.HPTRIM.SDK.TrimPropertySet.SetPropertyLong	(	PropertyIds	dnPropId,
		int	newValue
	)

bool HP.HPTRIM.SDK.TrimPropertySet.SetPropertyLong64	(	PropertyIds	dnPropId,
		long	newValue
	)

bool HP.HPTRIM.SDK.TrimPropertySet.SetPropertyString	(	PropertyIds	dnPropId,
		string	newValue
	)

bool HP.HPTRIM.SDK.TrimPropertySet.SetPropertyTrimObject	(	PropertyIds	dnPropId,
		TrimMainObject	newValue
	)

bool HP.HPTRIM.SDK.TrimPropertySet.SetPropertyUri	(	PropertyIds	dnPropId,
		TrimURI	newValue
	)

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

Property Documentation

virtual string HP.HPTRIM.SDK.TrimPropertySet.Caption

get

Gets the user-defined caption that has been associated with all TrimPropertySets of this type.

Database HP.HPTRIM.SDK.TrimPropertySet.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.

TrimException HP.HPTRIM.SDK.TrimPropertySet.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.

string HP.HPTRIM.SDK.TrimPropertySet.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.

virtual TrimIcon HP.HPTRIM.SDK.TrimPropertySet.Icon

get

Gets the icon value associated this TrimPropertySet.

bool HP.HPTRIM.SDK.TrimPropertySet.IsModified

get

Gets a boolean parameter indicating if any changes have been made to this object since it was first constructed, or last saved.