StringFormatName Class

Article
11/28/2016

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

Specifies the format of a StringAttributeMetadata attribute using the FormatName property.

For the Web API the corresponding type is StringFormatName ComplexType.

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

Inheritance Hierarchy

System.Object
Microsoft.Xrm.Sdk.Metadata.ConstantsBase<T>
Microsoft.Xrm.Sdk.Metadata.StringFormatName

Syntax

[DataContractAttribute(Name = "StringFormatName", Namespace = "https://schemas.microsoft.com/xrm/2013/Metadata")]
public sealed class StringFormatName : ConstantsBase<string>

<DataContractAttribute(Name := "StringFormatName", Namespace := "https://schemas.microsoft.com/xrm/2013/Metadata")>
Public NotInheritable Class StringFormatName
    Inherits ConstantsBase(Of String)

Constructors

	Name	Description
	StringFormatName()	Initializes a new instance of the StringFormatName class.

Properties

	Name	Description
	ExtensionData	(Inherited from ConstantsBase<T>.)
	Value	(Inherited from ConstantsBase<T>.)

Methods

	Name	Description
	Equals(Object)	Determines whether two instances are equal.(Overrides Object.Equals(Object).)
	GetHashCode()	Returns a hash code value for this type.(Overrides Object.GetHashCode().)
	GetType()	(Inherited from Object.)
	ToString()	(Inherited from Object.)

Fields

	Name	Description
	Email	Specifies to display the StringAttributeMetadata as an email address.
	Phone	Specifies to display the StringAttributeMetadata as an phone number.
	PhoneticGuide	Specifies to display the StringAttributeMetadata as an phonetic guide.
	Text	Specifies to display the StringAttributeMetadata as text.
	TextArea	Specifies to display the StringAttributeMetadata as a text area.
	TickerSymbol	Specifies to display the StringAttributeMetadata as a ticker symbol.
	Url	Specifies to display the StringAttributeMetadata as a URL.
	VersionNumber	Specifies to display the StringAttributeMetadata as a version number.

Operators

	Name	Description
	Equality(StringFormatName, StringFormatName)	Indicates whether two StringFormatName instances are the same.
	Implicit(String to StringFormatName)	Converts a string into a StringFormatName
	Inequality(StringFormatName, StringFormatName)	Indicates whether two StringFormatName instances are different.

Remarks

This class replaces the deprecated StringFormat enumeration used to set the StringAttributeMetadata.Format property.

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.