Compartilhar via


StringAttributeMetadata Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the metadata for an attribute of type String.

Namespace:   Microsoft.Xrm.Sdk.Metadata
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Xrm.Sdk.Metadata.MetadataBase
    Microsoft.Xrm.Sdk.Metadata.AttributeMetadata
      Microsoft.Xrm.Sdk.Metadata.StringAttributeMetadata

Syntax

[DataContractAttribute(Name = "StringAttributeMetadata", Namespace = "https://schemas.microsoft.com/xrm/2011/Metadata")]
[MetadataNameAttribute(LogicalName = "StringAttributeMetadata", 
    LogicalCollectionName = "StringAttributeDefinitions")]
public sealed class StringAttributeMetadata : AttributeMetadata
<DataContractAttribute(Name := "StringAttributeMetadata", Namespace := "https://schemas.microsoft.com/xrm/2011/Metadata")>
<MetadataNameAttribute(LogicalName := "StringAttributeMetadata",
    LogicalCollectionName := "StringAttributeDefinitions")>
Public NotInheritable Class StringAttributeMetadata
    Inherits AttributeMetadata

Constructors

Name Description
System_CAPS_pubmethod StringAttributeMetadata()

Initializes a new instance of the StringAttributeMetadata class

System_CAPS_pubmethod StringAttributeMetadata(String)

Initializes a new instance of the StringAttributeMetadata class

Properties

Name Description
System_CAPS_pubproperty AttributeOf

Gets the name of the attribute that this attribute extends.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty AttributeType

Gets the type for the attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty AttributeTypeName

Gets the name of the type for the attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty CanBeSecuredForCreate

Gets whether field-level security can be applied to prevent a user from adding data to this attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty CanBeSecuredForRead

Gets whether field-level security can be applied to prevent a user from viewing data from this attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty CanBeSecuredForUpdate

Gets whether field-level security can be applied to prevent a user from updating data for this attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty CanModifyAdditionalSettings

Gets or sets the property that determines whether any settings not controlled by managed properties can be changed.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty ColumnNumber

Gets an organization-specific ID for the attribute used for auditing.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty DeprecatedVersion

Gets the Microsoft Dynamics 365 version that the attribute was deprecated in.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty Description

Gets or sets the description of the attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty DisplayName

Gets or sets the display name for the attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty EntityLogicalName

Gets the logical name of the entity that contains the attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data.(Inherited from MetadataBase.)

System_CAPS_pubproperty Format

Gets or sets the format for the string

System_CAPS_pubproperty FormatName

Gets or sets the format for the string.

System_CAPS_pubproperty FormulaDefinition

Gets or sets the formula definition for calculated and rollup attributes.

System_CAPS_pubproperty HasChanged

Gets whether the item of metadata has changed.(Inherited from MetadataBase.)

System_CAPS_pubproperty ImeMode

Gets or sets the IME mode for the attribute.

System_CAPS_pubproperty InheritsFrom

This API supports the product infrastructure and is not intended to be used directly from your code. (Inherited from AttributeMetadata.)

System_CAPS_pubproperty IntroducedVersion

Gets a string identifying the solution version that the solution component was added in.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsAuditEnabled

Gets or sets the property that determines whether the attribute is enabled for auditing.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsCustomAttribute

Gets whether the attribute is a custom attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsCustomizable

Gets or sets the property that determines whether the attribute allows customization.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsFilterable

This API supports the product infrastructure and is not intended to be used directly from your code. (Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsGlobalFilterEnabled

(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsLocalizable

Gets whether the attribute supports localizable values.

System_CAPS_pubproperty IsLogical

Gets whether the attribute is a logical attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsManaged

Gets whether the attribute is part of a managed solution.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsPrimaryId

Gets whether the attribute represents the unique identifier for the record.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsPrimaryName

Gets or sets whether the attribute represents the primary attribute for the entity.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsRenameable

Gets or sets the property that determines whether the attribute display name can be changed.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsRetrievable

This API supports the product infrastructure and is not intended to be used directly from your code. (Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsSearchable

This API supports the product infrastructure and is not intended to be used directly from your code. (Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsSecured

Gets or sets whether the attribute is secured for field-level security.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsSortableEnabled

(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsValidForAdvancedFind

Gets or sets the property that determines whether the attribute appears in Advanced Find.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsValidForCreate

Gets whether the value can be set when a record is created.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsValidForRead

Gets whether the value can be retrieved.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty IsValidForUpdate

Gets whether the value can be updated.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty LinkedAttributeId

Gets or sets an attribute that is linked between appointments and recurring appointments.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty LogicalName

Gets or sets the logical name for the attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty MaxLength

Gets or sets the maximum length for the string.

System_CAPS_pubproperty MetadataId

Gets or sets a unique identifier for the metadata item.(Inherited from MetadataBase.)

System_CAPS_pubproperty RequiredLevel

Gets or sets the property that determines the data entry requirement level enforced for the attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty SchemaName

Gets or sets the schema name for the attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty SourceType

Gets or sets the value that indicates the source type for a calculated or rollup attribute.(Inherited from AttributeMetadata.)

System_CAPS_pubproperty SourceTypeMask

Gets the bitmask value that describes the sources of data used in a calculated attribute or whether the data sources are invalid.

System_CAPS_pubproperty YomiOf

For internal use only.

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Fields

Name Description
System_CAPS_pubfieldSystem_CAPS_static MaxSupportedLength

The maximum supported length is 4000 characters.

System_CAPS_pubfieldSystem_CAPS_static MinSupportedLength

The minimum supported length is 1 character.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Xrm.Sdk.Metadata Namespace
Customize entity attribute metadata

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright