DataObjectIdentifierConverter.ConvertToString Method

Definition

Namespace:

Microsoft.VisualStudio.Data.Framework

Assembly:

Microsoft.VisualStudio.Data.Framework.dll

Package:

Microsoft.VisualStudio.Data.Framework v17.10.40170

Overloads

ConvertToString(String, Object[])	Converts a set of identifier parts into a formatted string identifier.
ConvertToString(String, Object[], DataObjectIdentifierFormat)	Converts a set of identifier parts into a formatted string identifier, using the specified formatting option.

ConvertToString(String, Object[])

Converts a set of identifier parts into a formatted string identifier.

public:
 virtual System::String ^ ConvertToString(System::String ^ typeName, cli::array <System::Object ^> ^ identifier);

public string ConvertToString (string typeName, object[] identifier);

abstract member ConvertToString : string * obj[] -> string
override this.ConvertToString : string * obj[] -> string

Public Function ConvertToString (typeName As String, identifier As Object()) As String

Parameters

typeName

String

The name of a data object type.

identifier

Object[]

An array containing a set of identifier parts for a specified object.

Returns

String

A string representation made up from the identifier parts and formatted according to the default formatting option.

Implements

ConvertToString(String, Object[])

Exceptions

ArgumentNullException

The typeName parameter is null.

ConvertToString(String, Object[], DataObjectIdentifierFormat)

Converts a set of identifier parts into a formatted string identifier, using the specified formatting option.

public:
 virtual System::String ^ ConvertToString(System::String ^ typeName, cli::array <System::Object ^> ^ identifier, Microsoft::VisualStudio::Data::Services::DataObjectIdentifierFormat format);

public string ConvertToString (string typeName, object[] identifier, Microsoft.VisualStudio.Data.Services.DataObjectIdentifierFormat format);

abstract member ConvertToString : string * obj[] * Microsoft.VisualStudio.Data.Services.DataObjectIdentifierFormat -> string
override this.ConvertToString : string * obj[] * Microsoft.VisualStudio.Data.Services.DataObjectIdentifierFormat -> string

Public Function ConvertToString (typeName As String, identifier As Object(), format As DataObjectIdentifierFormat) As String

Parameters

typeName

String

The name of a data object type.

identifier

Object[]

An array containing a set of identifier parts for a specified object.

format

DataObjectIdentifierFormat

A value from the enumeration DataObjectIdentifierFormat indicating the format of the string.

Returns

String

A string representation made up from the identifier parts and formatted as indicated by the specified formatting option.

Implements

ConvertToString(String, Object[], DataObjectIdentifierFormat)

Exceptions

ArgumentNullException

The typeName parameter is null.