# MTProperty

Generic holder of a single property (core or extended). A property is one of the data fields of an entity such as priceable item or product offering. A property can have many attributes.

To view an object model diagram that includes MTProperty, click here.

## Program ID

Metratech.MTProperty.1

## Methods

GetMetaData | Returns the meta data for this property (from meta data).

## Properties

Value | The property value.
Attributes | The attributes of this property.
Name | The property name, also known as the distinguished name. This is the name used in business object (for example, "Description") (from meta data).
DisplayName | The localized name of property (from meta data).
DataType | The data type (an MSIX type) (from meta data). Types must be a value in the PropValType enum type.
DataTypeAsString | The helper to show MSIX type as string (from meta data).
EnumSpace | If DataType is enum, this property specifies the MetraTech enum space (from meta data).
EnumType | If DataType is enum, this property specifies the MetraTech enum type (from meta data).
Length | Further specifies the DataType for a string in terms of maximum length in characters (from meta data).
Required | If this boolean property is true, the value must be specified (from meta data).
Extended | This boolean property returns false for a core property, true for an extended property (from meta data).
PropertyGroup | This property designates what group that this property belongs to, allowing for the grouping of properties (from meta data).
Overrideable | This boolean property specifies whether this property value can be overridden (from meta data). This property is used to denote priceable item instances that override the values of their templates.
SummaryView | Specifies whether this property is to be included in summary views (from meta data).

# Method Detail

## GetMetaData

This method returns the meta data for this property (from meta data).

### Visual Basic Syntax

GetMetaData() As MTPropertyMetaData

### C++ Syntax

HRESULT GetMetaData([out, retval] IMTPropertyMetaData** apMetaData);

# Property Detail

## Value

Specifies the property value.

### Visual Basic Syntax

Property Value As Variant

### C++ Syntax

HRESULT Value([out, retval] VARIANT *pVal);

HRESULT Value([in] VARIANT newVal);

## Attributes

Specifies the attributes of this property.

### Visual Basic Syntax

Property Attributes As MTAttributes

### C++ Syntax

HRESULT Attributes([out, retval] IMTAttributes **pVal);

## Name

This property denotes the property name, also know as the distinguished name. This is the name used in business object (for example, "Description") (from meta data).

### Visual Basic Syntax

Property Name As String

### C++ Syntax

HRESULT Name([out, retval] BSTR *pVal);

## DisplayName

This property establishes the localized name of property (from meta data).

### Visual Basic Syntax

Property DisplayName As String

### C++ Syntax

HRESULT DisplayName([out, retval] BSTR *pVal);

## DataType

These properties set the data type (an MSIX type) (from meta data). Types must be a value in the PropValType enum type.

### Visual Basic Syntax

Property DataType As PropValType

### C++ Syntax

HRESULT DataType([out, retval] PropValType *pVal);

## DataTypeAsString

This property is the helper to show MSIX type as string (from meta data).

### Visual Basic Syntax

Property DataTypeAsString As String

### C++ Syntax

HRESULT DataTypeAsString([out, retval] BSTR *pVal);

## EnumSpace

If the DataType is enum, this property specifies the MetraTech enum space (from meta data).

### Visual Basic Syntax

Property EnumSpace As String

### C++ Syntax

HRESULT EnumSpace([out, retval] BSTR *pVal);

## EnumType

If the DataType is enum, this property specifies the MetraTech enum type (from meta data).

### Visual Basic Syntax

Property EnumSpace As Variant

### C++ Syntax

HRESULT EnumType([out, retval] BSTR *pVal);

## Length

This property further specifies the DataType for a string in terms of maximum length in characters (from meta data).

### Visual Basic Syntax

Property Length As Long

### C++ Syntax

HRESULT Length([out, retval] long *pVal);

## Required

If this boolean property is true, the value must be specified (from meta data).

### Visual Basic Syntax

Property Required As Boolean

### C++ Syntax

HRESULT Required([out, retval] VARIANT_BOOL *pVal);

## Extended

This boolean property returns false for a core property, true for an extended property (from meta data).

### Visual Basic Syntax

Property Extended As Boolean

### C++ Syntax

HRESULT Extended([out, retval] VARIANT_BOOL *pVal);

## PropertyGroup

This property designates what group that this property belongs to, allowing for the grouping of properties (from meta data).

### Visual Basic Syntax

Property PropertyGroup As String

### C++ Syntax

HRESULT PropertyGroup([out, retval] BSTR *pVal);

## Overrideable

This boolean property specifies whether a property value can be overridden (from meta data). This property is used to denote priceable item instances that override the values of their templates.

### Visual Basic Syntax

Property Overrideable As Boolean

### C++ Syntax

HRESULT Overrideable([out, retval] VARIANT_BOOL *pVal);

## SummaryView

Specifies whether this property is to be included in summary views (from meta data).

### Visual Basic Syntax

Property SummaryView As Boolean

### C++ Syntax

HRESULT SummaryView([out, retval] VARIANT_BOOL *pVal);