# MTPropertyMetaData

Describes an MTProperty object.

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

## Program ID

Metratech.MTPropertyMetaData.1

## Methods

None.

## Properties

Name | The property name (also called distinguished name). The name used in business object; for example, "Description".
DisplayName | The localized name of the property displayed to the user.
DataType | The MSIX type of the property. Types must be a value in the PropValType enum type.
DataTypeAsString | The helper to show the MSIX type as a string.
Length | Further specifies the DataType for a string in terms of maximum length in characters.
EnumSpace | If the DataType is enum, specifies the MetraTech enum space.
EnumType | If the DataType is enum, specifies the MetraTech enum type.
Required | If this boolean property is true, the value cannot be NULL.
DefaultValue | The default value of the property.
Extended | This boolean property returns false for a core property, true for an extended property.
PropertyGroup | The group that this property belongs to; this allows for grouping of properties.
DBColumnName | The name used in the database, such as m_desc.
DBAliasName | The alias name of this property in a rowset (eg. "t_ep__c_ExternalInformationURL") Note: This name is composed of DBTableName and DBColumnName.
DBTableName | The database table that stores this property.
DBDataType | The data type in database. Possible values include int, varchar, etc.
Attributes | The attributes for this property.
Overrideable | Specifies whether this property value can be overridden. This is used in priceable item instances that override values of their templates.
SummaryView | Specifies whether this property is to be included in summary views.

# Property Detail

## Name

Property name (also called distinguished name). The name used in business object; for example, "Description".

### Visual Basic Syntax

Property Name As String

### C++ Syntax

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

HRESULT Name([in] BSTR newVal);

## DisplayName

Localized name of the property displayed to the user.

### Visual Basic Syntax

Property DisplayName As String

### C++ Syntax

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

HRESULT DisplayName([in] BSTR pVal);

## DataType

MSIX type of the property. 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);

HRESULT DataType([in] PropValType newVal);

## DataTypeAsString

Helper to show the MSIX type as a string.

### Visual Basic Syntax

Property DataTypeAsString As String

### C++ Syntax

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

## Length

Further specifies DataType for a string in terms of maximum length in characters.

### Visual Basic Syntax

Property Length As Long

### C++ Syntax

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

HRESULT Length([in] long newVal);

## EnumSpace

If the DataType is enum, specifies the MetraTech enum space.

### Visual Basic Syntax

Property EnumSpace As String

### C++ Syntax

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

HRESULT EnumSpace([in] BSTR newVal);

## EnumType

If the DataType is enum, specifies the MetraTech enum type.

### Visual Basic Syntax

Property EnumType As String

### C++ Syntax

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

EnumType([in] BSTR newVal);

## Required

If true, the value cannot be NULL.

### Visual Basic Syntax

Property Required As Boolean

### C++ Syntax

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

HRESULT Required([in] VARIANT_BOOL newVal);

## DefaultValue

The default value of the property.

### Visual Basic Syntax

Property DefaultValue As Variant

### C++ Syntax

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

HRESULT DefaultValue([in] VARIANT newVal);

## Extended

This boolean property returns false for a core property, true for an extended property.

### Visual Basic Syntax

Property Extended As Boolean

### C++ Syntax

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

HRESULT Extended([in] VARIANT_BOOL newVal);

## PropertyGroup

Group that this property belongs to; this allows for grouping of properties.

### Visual Basic Syntax

Property PropertyGroup As String

### C++ Syntax

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

HRESULT PropertyGroup([in] BSTR newVal);

## DBColumnName

Name used in database, such as m_desc.

### Visual Basic Syntax

Property DBColumnName As String

### C++ Syntax

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

HRESULT DBColumnName([in] BSTR newVal);

## DBAliasName

Alias name of this property in a rowset (eg. "t_ep__c_ExternalInformationURL")

Composed of DBTableName and DBColumnName.

### Visual Basic Syntax

Property DBAliasName As String

### C++ Syntax

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

## DBTableName

Database table that stores this property.

### Visual Basic Syntax

Property DBTableName As String

### C++ Syntax

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

HRESULT DBTableName([in] BSTR newVal);

## DBDataType

Data type in database. Possible values include int, varchar, etc.

### Visual Basic Syntax

Property DBDataType As String

### C++ Syntax

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

## Attributes

This property specifies the attributes for this property.

### Visual Basic Syntax

Property Attributes As MTAttributes

### C++ Syntax

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

## Overrideable

This property specifies whether this property value can be overridden. This is used in priceable item instances that override values of their templates.

### Visual Basic Syntax

Property Overrideable As Boolean

### C++ Syntax

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

## SummaryView

This property specifies whether this property is to be included in summary views.

### Visual Basic Syntax

Property SummaryView As Boolean

### C++ Syntax

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