AdoDotNetObjectIdentifierConverter Class

  • Article

Provides the ability to convert identifiers from strings to identifier parts and vice versa, and the ability to format identifiers.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.Framework.DataSiteableObject<IVsDataConnection>
    Microsoft.VisualStudio.Data.Framework.DataObjectIdentifierConverter
      Microsoft.VisualStudio.Data.Framework.AdoDotNet.AdoDotNetObjectIdentifierConverter

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

Syntax

'Declaration
Public Class AdoDotNetObjectIdentifierConverter _
    Inherits DataObjectIdentifierConverter

public class AdoDotNetObjectIdentifierConverter : DataObjectIdentifierConverter

public ref class AdoDotNetObjectIdentifierConverter : public DataObjectIdentifierConverter

type AdoDotNetObjectIdentifierConverter =  
    class 
        inherit DataObjectIdentifierConverter 
    end

public class AdoDotNetObjectIdentifierConverter extends DataObjectIdentifierConverter

The AdoDotNetObjectIdentifierConverter type exposes the following members.

Constructors

  Name Description
Public method AdoDotNetObjectIdentifierConverter() Initializes a new instance of the AdoDotNetObjectIdentifierConverter class.
Public method AdoDotNetObjectIdentifierConverter(IVsDataConnection) Initializes a new instance of the AdoDotNetObjectIdentifierConverter class with the specified data connection object.

Top

Properties

  Name Description
Protected property CompositeIdentifierSeparator Gets the identifier separator. By default, it is set to the dot character.
Public property Site Gets or sets the object site. (Inherited from DataSiteableObject<T>.)

Top

Methods

  Name Description
Protected method BuildString Concatenates identifier parts into a string and inserts the separator character in between. (Overrides DataObjectIdentifierConverter.BuildString(String, array<String[], DataObjectIdentifierFormat).)
Public method ConvertToArray Converts a formatted string identifier into its equivalent set of identifier parts. (Inherited from DataObjectIdentifierConverter.)
Public method ConvertToString(String, array<Object[]) Converts a set of identifier parts into a formatted string identifier. (Inherited from DataObjectIdentifierConverter.)
Public method ConvertToString(String, array<Object[], DataObjectIdentifierFormat) Converts a set of identifier parts into a formatted string identifier, using the specified formatting option. (Inherited from DataObjectIdentifierConverter.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method FormatPart By default, adds quotation marks to the identifier part if the format parameter reveals that quotation marks are required. Override to customize the formatting that is added to the identifier part. (Overrides DataObjectIdentifierConverter.FormatPart(String, Object, DataObjectIdentifierFormat).)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnSiteChanged Handles the SiteChanged event. (Overrides DataSiteableObject<T>.OnSiteChanged(EventArgs).)
Protected method RequiresQuoting Indicates whether the specified identifier part requires quotation marks.
Protected method SplitIntoParts Divides the specified string version of an identifier into a set of formatted identifier parts by using the identifier separator character. (Overrides DataObjectIdentifierConverter.SplitIntoParts(String, String).)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method UnformatPart Removes formatting of identifier parts, such as trimming leading and trailing spaces and removing quotation marks. (Overrides DataObjectIdentifierConverter.UnformatPart(String, String).)

Top

Events

  Name Description
Public event SiteChanged Occurs when the Site property is changed. (Inherited from DataSiteableObject<T>.)

Top

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.

See Also

Reference

Microsoft.VisualStudio.Data.Framework.AdoDotNet Namespace