Share via


IndexedXmlPath Class

Represents an indexed XML path.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.IndexedXmlPath

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class IndexedXmlPath _
    Inherits NamedSmoObject _
    Implements ISfcSupportsDesignMode, IMarkForDrop
'Usage
Dim instance As IndexedXmlPath
public sealed class IndexedXmlPath : NamedSmoObject, 
    ISfcSupportsDesignMode, IMarkForDrop
public ref class IndexedXmlPath sealed : public NamedSmoObject, 
    ISfcSupportsDesignMode, IMarkForDrop
[<SealedAttribute>]
type IndexedXmlPath =  
    class 
        inherit NamedSmoObject 
        interface ISfcSupportsDesignMode 
        interface IMarkForDrop 
    end
public final class IndexedXmlPath extends NamedSmoObject implements ISfcSupportsDesignMode, IMarkForDrop

The IndexedXmlPath type exposes the following members.

Constructors

  Name Description
Public method IndexedXmlPath() Initializes a new instance of the IndexedXmlPath class.
Public method IndexedXmlPath(Index, String) Initializes a new instance of the IndexedXmlPath class.

Top

Properties

  Name Description
Public property DataType Gets or sets the SQL data type of the path annotated with the keyword SQL.
Public property ID Gets or sets the ID of the IndexedXmlPath.
Public property IsNode Gets or sets a value that indicates whether ‘node()’ optimization hint is applied for the given XML path.
Public property IsSingleton Gets or sets a value that indicates whether ‘SINGLETON’ optimization hint is applied for the given XML path.
Public property IsXQueryMaxlengthInferred Gets or sets a value that indicates whether the maximum length is inferred from XML schema, applicable only for xs:string and xs:untypedAtomic types.
Public property IsXQueryTypeInferred Gets or sets a value that indicates whether XQuery type is inferred for the given XML path.
Public property Name Gets or sets the name of the IndexedXmlPath. (Overrides NamedSmoObject.Name.)
Public property Parent Gets or sets the parent of the IndexedXmlPath.
Public property Path Gets or sets the path of the IndexedXmlPath.
Public property PathType Gets or sets the type of indexed path. Could be XQuery or SQL.
Public property PathTypeDesc Gets or sets the string representing the path type description of the IndexedXmlPath.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property SqlTypeCollationName Gets or sets the name of the collation of the type if it is character-based; otherwise null.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Public property XmlComponentID Gets or sets the unique ID of the XML schema component in the database.
Public property XQueryMaxLength Gets or sets the maximum length optimization hint, in characters, applicable for xs:string and xs:untypedAtomic types only, null otherwise.
Public property XQueryTypeDescription Gets or sets the string representing the XQuery type description if XQuery type is specified; otherwise null.

Top

Methods

  Name Description
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method MarkForDrop Marks the IndexedXmlPath for deletion.
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetParent Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate property ISfcSupportsDesignMode.IsDesignMode Gets or sets whether IndexedXmlPath supports design mode.

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.SqlServer.Management.Smo Namespace