IndexedXmlPath Class

Article
2014-08-11

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
	IndexedXmlPath()	Initializes a new instance of the IndexedXmlPath class.
	IndexedXmlPath(Index, String)	Initializes a new instance of the IndexedXmlPath class.

Top

Properties

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

Top

Methods

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

Top

Events

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

Top

Explicit Interface Implementations

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