StringAttributeMetadata Class

Definition

Namespace:

Microsoft.Xrm.Sdk.Metadata

Assembly:

Microsoft.Xrm.Sdk.dll

Package:

Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Contains the metadata for an attribute of type String.

public ref class StringAttributeMetadata sealed : Microsoft::Xrm::Sdk::Metadata::AttributeMetadata

[Microsoft.Xrm.Sdk.Metadata.MetadataName(LogicalCollectionName="StringAttributeDefinitions", LogicalName="StringAttributeMetadata")]
[System.Runtime.Serialization.DataContract(Name="StringAttributeMetadata", Namespace="http://schemas.microsoft.com/xrm/2011/Metadata")]
public sealed class StringAttributeMetadata : Microsoft.Xrm.Sdk.Metadata.AttributeMetadata

[<Microsoft.Xrm.Sdk.Metadata.MetadataName(LogicalCollectionName="StringAttributeDefinitions", LogicalName="StringAttributeMetadata")>]
[<System.Runtime.Serialization.DataContract(Name="StringAttributeMetadata", Namespace="http://schemas.microsoft.com/xrm/2011/Metadata")>]
type StringAttributeMetadata = class
    inherit AttributeMetadata

Public NotInheritable Class StringAttributeMetadata
Inherits AttributeMetadata

Inheritance

Object

MetadataBase

AttributeMetadata

StringAttributeMetadata

Attributes

MetadataNameAttribute DataContractAttribute

Constructors

StringAttributeMetadata()	Initializes a new instance of the StringAttributeMetadata class
StringAttributeMetadata(String)	Initializes a new instance of the StringAttributeMetadata class

Fields

MaxSupportedLength	The maximum supported length is 4000 characters.
MinSupportedLength	The minimum supported length is 1 character.

Properties

AttributeOf	Gets the name of the attribute that this attribute extends. (Inherited from AttributeMetadata)
AttributeType	Gets the type for the attribute. (Inherited from AttributeMetadata)
AttributeTypeName	Gets the name of the type for the attribute. (Inherited from AttributeMetadata)
AutoNumberFormat	(Inherited from AttributeMetadata)
CanBeSecuredForCreate	Gets whether field-level security can be applied to prevent a user from adding data to this attribute. (Inherited from AttributeMetadata)
CanBeSecuredForRead	Gets whether field-level security can be applied to prevent a user from viewing data from this attribute. (Inherited from AttributeMetadata)
CanBeSecuredForUpdate	Gets whether field-level security can be applied to prevent a user from updating data for this attribute. (Inherited from AttributeMetadata)
CanModifyAdditionalSettings	Gets or sets the property that determines whether any settings not controlled by managed properties can be changed. (Inherited from AttributeMetadata)
ColumnNumber	Gets an organization-specific ID for the attribute used for auditing. (Inherited from AttributeMetadata)
CreatedOn	(Inherited from AttributeMetadata)
DatabaseLength
DeprecatedVersion	Gets the Microsoft Dynamics 365 version that the attribute was deprecated in. (Inherited from AttributeMetadata)
Description	Gets or sets the description of the attribute. (Inherited from AttributeMetadata)
DisplayName	Gets or sets the display name for the attribute. (Inherited from AttributeMetadata)
EntityLogicalName	Gets the logical name of the entity that contains the attribute. (Inherited from AttributeMetadata)
ExtensionData	Gets or sets the structure that contains extra data. (Inherited from MetadataBase)
ExternalName	(Inherited from AttributeMetadata)
Format	Gets or sets the format for the string
FormatName	Gets or sets the format for the string.
FormulaDefinition	Gets or sets the formula definition for calculated and rollup attributes.
HasChanged	Gets whether the item of metadata has changed. (Inherited from MetadataBase)
ImeMode	Gets or sets the IME mode for the attribute.
InheritsFrom	(Inherited from AttributeMetadata)
IntroducedVersion	Gets a string identifying the solution version that the solution component was added in. (Inherited from AttributeMetadata)
IsAuditEnabled	Gets or sets the property that determines whether the attribute is enabled for auditing. (Inherited from AttributeMetadata)
IsCustomAttribute	Gets whether the attribute is a custom attribute. (Inherited from AttributeMetadata)
IsCustomizable	Gets or sets the property that determines whether the attribute allows customization. (Inherited from AttributeMetadata)
IsDataSourceSecret	(Inherited from AttributeMetadata)
IsFilterable	(Inherited from AttributeMetadata)
IsGlobalFilterEnabled	(Inherited from AttributeMetadata)
IsLocalizable	Gets whether the attribute supports localizable values.
IsLogical	Gets whether the attribute is a logical attribute. (Inherited from AttributeMetadata)
IsManaged	Gets whether the attribute is part of a managed solution. (Inherited from AttributeMetadata)
IsPrimaryId	Gets whether the attribute represents the unique identifier for the record. (Inherited from AttributeMetadata)
IsPrimaryName	Gets or sets whether the attribute represents the primary attribute for the entity. (Inherited from AttributeMetadata)
IsRenameable	Gets or sets the property that determines whether the attribute display name can be changed. (Inherited from AttributeMetadata)
IsRequiredForForm	Gets or sets whether the attribute must be included in a form in a model-driven app. (Inherited from AttributeMetadata)
IsRetrievable	(Inherited from AttributeMetadata)
IsSearchable	(Inherited from AttributeMetadata)
IsSecured	Gets or sets whether the attribute is secured for field-level security. (Inherited from AttributeMetadata)
IsSortableEnabled	(Inherited from AttributeMetadata)
IsValidForAdvancedFind	Gets or sets the property that determines whether the attribute appears in Advanced Find. (Inherited from AttributeMetadata)
IsValidForCreate	Gets whether the value can be set when a record is created. (Inherited from AttributeMetadata)
IsValidForForm	Gets or sets whether the attribute can be added to a form in a model-driven app. (Inherited from AttributeMetadata)
IsValidForGrid	Gets or sets whether the attribute can be included in a view. (Inherited from AttributeMetadata)
IsValidForRead	Gets whether the value can be retrieved. (Inherited from AttributeMetadata)
IsValidForUpdate	Gets whether the value can be updated. (Inherited from AttributeMetadata)
IsValidODataAttribute	Gets whether the attribute represents a property that is available in the Web API. (Inherited from AttributeMetadata)
LinkedAttributeId	Gets or sets an attribute that is linked between appointments and recurring appointments. (Inherited from AttributeMetadata)
LogicalName	Gets or sets the logical name for the attribute. (Inherited from AttributeMetadata)
MaxLength	Gets or sets the maximum length for the string.
MetadataId	Gets or sets a unique identifier for the metadata item. (Inherited from MetadataBase)
ModifiedOn	(Inherited from AttributeMetadata)
RequiredLevel	Gets or sets the property that determines the data entry requirement level enforced for the attribute. (Inherited from AttributeMetadata)
SchemaName	Gets or sets the schema name for the attribute. (Inherited from AttributeMetadata)
Settings	Internal use only. (Inherited from AttributeMetadata)
SourceType	Gets or sets the value that indicates the source type for a calculated, rollup, or formula attribute. (Inherited from AttributeMetadata)
SourceTypeMask	Gets the bitmask value that describes the sources of data used in a calculated attribute or whether the data sources are invalid.
YomiOf	For internal use only.