DataObjectIdentifierConverter.ConvertToString Method (String, array<Object , DataObjectIdentifierFormat)

Article
02/23/2011

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

Namespace: Microsoft.VisualStudio.Data.Framework
Assembly: Microsoft.VisualStudio.Data.Framework (in Microsoft.VisualStudio.Data.Framework.dll)

Syntax

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

public string ConvertToString(
    string typeName,
    Object[] identifier,
    DataObjectIdentifierFormat format
)

public:
virtual String^ ConvertToString(
    String^ typeName, 
    array<Object^>^ identifier, 
    DataObjectIdentifierFormat format
) sealed

abstract ConvertToString : 
        typeName:string * 
        identifier:Object[] * 
        format:DataObjectIdentifierFormat -> string 
override ConvertToString : 
        typeName:string * 
        identifier:Object[] * 
        format:DataObjectIdentifierFormat -> string

public final function ConvertToString(
    typeName : String, 
    identifier : Object[], 
    format : DataObjectIdentifierFormat
) : String

Parameters

typeName
Type: System.String
The name of a data object type.

identifier
Type: array<System.Object[]
An array containing a set of identifier parts for a specified object.

format
Type: Microsoft.VisualStudio.Data.Services.DataObjectIdentifierFormat
A value from the enumeration DataObjectIdentifierFormat indicating the format of the string.

Return Value

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

Implements

IVsDataObjectIdentifierConverter.ConvertToString(String, array<Object[], DataObjectIdentifierFormat)

Exceptions

Exception	Condition
ArgumentNullException	The typeName parameter is nulla null reference (Nothing in Visual Basic).

Remarks

The base implementation makes calls into the FormatPart(String, Object, Boolean) and BuildString(String, array<String[], Boolean) methods, which carry out smaller parts of the operation.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via