| MDM Object Model Reference |
|
|
|
|
A Field object roughly corresponds to a question or information item. However, you do not create a Field object directly.
Remarks
The Variable and VariableInstance objects inherit the properties and methods of IField.
Groups
| IMDMLabeledObject | The MDMLabeledObject class gives access to an object's Label objects in which texts are stored. Generally you do not create an object of this type directly. |
| Read-only Properties | |
 Labels |
A collection of Label objects, one for each LabelType. LabelTypes define different types of labels, so that more than one text can be defined in each language for each user context. For example, you can define a LabelType of Instruction for texts that give instructions to interviewers. The default LabelType is Label, which is used for question and category texts in data collection user contexts and variable descriptions in data analysis user contexts. |
| Read/Write Properties | |
| Label |
Sets the object's default text for the current user context and language and gets the object's default text for the current user context and language in accordance with any alternatives rules that have been defined. This is a shortcut to MyObject.Labels("Label").Text. |
| IMDMObject | One of the structural objects around which the rest of the metadata is constructed. Generally you do not create an object of this type directly. |
| Read-only Properties | |
| IsReference |
Returns True if this object contains a reference to a template object, rather than defining the object itself. |
| IsSystem |
Returns True if this object is a system variable. System variables are present if IDocument.IncludeSystemVariables is set to True. |
| ObjectTypeValue |
Returns the type of the object; for example, IVariable, IClass, IGrid, ICompound, IElements, etc. |
| Parent |
Returns the object's parent object. |
| Properties |
A list of the object's custom properties. |
| UUID |
The object's unique identifier. This is linked to the object's Name and remains the same across all versions. |
| Read/Write Properties | |
| Document |
Sets and retrieves the Document object to which this object belongs. |
| Name |
The name of the object. This is the name that you give an object when you create it. The name must be unique within the collection to which it belongs. In addition, an object's name must be such that its full name is unique within the Document. |
| Read-only Properties | |
| Categories |
A non-hierarchical collection (flat list) of all of the categories in the Elements collection of the current object. |
| EffectiveMaxValue |
Defines the maximum value permitted for responses to the question when MaxValue has not been set. EffectiveMaxValue inherits from DataMaxValue. |
| EffectiveMinValue |
Defines the minimum value permitted for responses to the question when MinValue has not been set. |
| Elements |
A collection of all of the Element and Elements objects under the current object. |
| IsSystemVariable |
Returns True if this is a system variable. |
| Read/Write Properties | |
| DataType |
Defines the type of data that will be collected by the question; for example, categorical, integer, text, etc. |
| MaxValue |
The maximum value permitted for responses to this question. When this value has not been set and a range expression has not been used, you should obtain the maximum value from EffectiveMaxValue. |
| MinValue |
The minimum value permitted for responses to this question. When this value has not been set and a range expression has not been used, you should obtain the minimum value from EffectiveMinValue. |
| Reference |
A Reference to another object of the same type that you are using as a template. The object that you are referencing must be defined in the Types collection, either of the Document object, or of a parent object (such as ICompound.Types if the object is part of a Compound object). |
Interface ID
The ID of the IField interface is 2A9676C9-DBF1-41ec-A0CC-B03D58510C6B.
See Also
IField