Skip navigation  
Glossary  |  General Information  
   Content Services User Administration API
     Search in CS User Admin API Overview   |   API Classes   |   Enumeration Constants   |   Status Codes  
Level 1 Overview
Level 1 API Classes
Level 2 mezSession
Level 2 mezObject
Level 2 mezProperty
Level 2     Methods
Level 2     AddChild
Level 2     ConvertIndexed
Level 2     Expand
Level 2     GetActionListItem
Level 2     GetValueList
Level 2     GetValueListItem
Level 2     NewChild
Level 2     RemoveChild
Level 2     SetPropertyData
Level 2     Validate
Level 2     Properties
Level 2     bDisplayInPropSheet
Level 2     bDisplayInTree
Level 2     bHasValueList
Level 2     bIsAddableFromNewParent
Level 2     bIsDataVisible
Level 2     bIsExpandable
Level 2     bIsIndexed
Level 2     bIsKeyPart
Level 2     bIsModifiable
Level 2     bIsModified
Level 2     bIsRequired
Level 2     bMustPick
Level 2     bValueListMoreAvailable
Level 2     eParentAccessLevel
Level 2     ePropertyDataType
Level 2     ePropertyType
Level 2     eSortType
Level 2     hSctxHndl
Level 2     iActionListCount
Level 2     iParentObjectNumber
Level 2     iPropertyLength
Level 2     iPropertyNum
Level 2     iPropertyRefAttr
Level 2     iRefObjectNum
Level 2     lValueListCount
Level 2     mzList
Level 2     sParentKeyValue
Level 2     sPropertyData
Level 2     sPropertyName
Level 2 mezList
Level 2 mezUtility
Level 1 Enumeration Constants
Level 1 Status Codes
Level 1 General Information
   

mezProperty Class

The mezProperty class is used to represent the properties of a Content Services mezObject, where each property object can be either a single value or a list of objects. Single value mezProperty objects contain one data value that is relevant to the property type. List mezProperty objects contain a mezList object, which in turn contains zero or more mezObjects.

Each mezProperty object identifies the property type of the object, in addition to including the single data value for the property. Some single value mezProperty objects supply a set of values for the property. This set is normally displayed using a drop down list or similar control in the user interface. The user chooses one value from the supplied list to apply to the property. The GetValueList() and GetValueListItem() methods can be used to retrieve these data values.

A mezProperty object that contains a list of objects is created by calling the Expand() method to generate the mezList object and populate it with child mezObjects. The mezList object provides methods that enable access to the mezObjects contained in the list.

  Methods

AddChild

adds a new child mezObject to the property object's mzList property collection (mezList)

ConvertIndexed

converts an indexed property object's numeric property values into strings, and vice-versa

Expand

(list type property objects only) used to generate the property object's mzList property collection and populate it with child mezObjects

GetActionListItem

retrieves an individual action item from the property object's action list

GetValueList

initializes the property object's value list

GetValueListItem

retrieves a value from the property object's mzList property collection (mezList)

NewChild

creates a new child mezObject for the property object

RemoveChild

removes a child mezObject from the property object's mzList property collection (mezList); valid only for mezObjects of e_ObjectState: eObjStateNew or eObjStateDeleted

SetPropertyData

(single value type property objects only) applies a new data value to a property

Validate

validates a specified or the current value for a property object

  Properties

bDisplayInPropSheet

indicates whether the property object should be displayed along with other single value properties in a property sheet

bDisplayInTree

indicates whether the property object should be displayed as a child of it's parent mezObject, in a tree view

bHasValueList

indicates whether the property object has a list of values that either must be or may be selected from to set the property value

bIsAddableFromNewParent

indicates whether child objects may be added to the property object, although its parent mezObject is new and has not yet been stored in the CS library

bIsDataVisible

indicates whether the value for the property object should be visible

bIsExpandable

indicates whether the property object may have child objects associated with it

bIsIndexed

indicates whether the property object has a defined list of values that the user must choose from when setting this property

bIsKeyPart

indicates whether the property object is part of its parent mezObject's key

bIsModifiable

indicates when the user has permission to modify the value of the property object

bIsModified

indicates when the value of the property object has been modified

bIsRequired

indicates whether the property object must have a value

bMustPick

indicates whether the value for the property object must be chosen from a provided list values

bValueListMoreAvailable

indicates there are more values available in the property object's value list

eParentAccessLevel

the level of user access to the parent mezObject, using the e_ObjectAccess enumeration

ePropertyDataType

the data type of the property object, using the e_PropertyDataType enumeration

ePropertyType

indicates whether the property object is a single value or list type, using the e_PropertyType enumeration

eSortType

specifies whether the values for the property object should be sorted numerically (right justified) or alphanumerically (left justified)

hSctxHndl

the handle of the user session into the CS library

iActionListCount

the number of actions contained in the property object's action list

iParentObjectNumber

the object number for the property object's parent

iPropertyLength

the display length of the property object

iPropertyNum

the numeric identifier for the property object's type

iPropertyRefAttr

returns the property number of the property object that Content Services uses to create the value list for the property

iRefObjectNum

(list type property objects only) returns the object number of the property objects' child objects

lValueListCount

returns the total number of values contained in the property object's value list

mzList

returns a reference to the property object's embedded mezList object

sParentKeyValue

the value for the property object's parent's key

sPropertyData

returns the current value of property object

sPropertyName

the user friendly name for the type of the property object