DataObjectIdentifierConverter.ConvertToString Method

Definition

Converts a set of identifier parts into a formatted string identifier based on the specified formatting options.

public:
 virtual System::String ^ ConvertToString(System::String ^ typeName, cli::array <System::Object ^> ^ identifier, Microsoft::VisualStudio::Data::DataObjectIdentifierFormat format);
public virtual string ConvertToString (string typeName, object[] identifier, Microsoft.VisualStudio.Data.DataObjectIdentifierFormat format);
abstract member ConvertToString : string * obj[] * Microsoft.VisualStudio.Data.DataObjectIdentifierFormat -> string
override this.ConvertToString : string * obj[] * Microsoft.VisualStudio.Data.DataObjectIdentifierFormat -> string
Public Overridable 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 set of flags indicating how to format the resulting string.

Returns

Returns a partially or fully formatted identifier, depending on which parts of the input array were specified.

Exceptions

The typeName parameter is null.

Applies to