DataObjectIdentifierConverter.ConvertToString Method
Converts a set of identifier parts into a formatted string identifier based on the specified formatting options.
Namespace: Microsoft.VisualStudio.Data
Assembly: Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)
Syntax
'Declaration
Public Overridable Function ConvertToString ( _
typeName As String, _
identifier As Object(), _
format As DataObjectIdentifierFormat _
) As String
public virtual string ConvertToString(
string typeName,
Object[] identifier,
DataObjectIdentifierFormat format
)
public:
virtual String^ ConvertToString(
String^ typeName,
array<Object^>^ identifier,
DataObjectIdentifierFormat format
)
abstract ConvertToString :
typeName:string *
identifier:Object[] *
format:DataObjectIdentifierFormat -> string
override ConvertToString :
typeName:string *
identifier:Object[] *
format:DataObjectIdentifierFormat -> string
public function ConvertToString(
typeName : String,
identifier : Object[],
format : DataObjectIdentifierFormat
) : String
Parameters
typeName
Type: System.StringThe 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.DataObjectIdentifierFormatA set of flags indicating how to format the resulting string.
Return Value
Type: System.String
Returns a partially or fully formatted identifier, depending on which parts of the input array were specified.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentNullException | The typeName parameter is null. |
Remarks
Normally a provider would not override this method directly. The base implementation makes calls into the FormatPart and BuildString 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.