Share via

FullTextIndexColumn Class

  • Article

The FullTextIndexColumn object represents a Microsoft Search full-text index column. 

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.FullTextIndexColumn

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

Syntax

'Declaration
Public NotInheritable Class FullTextIndexColumn _
    Inherits ScriptNameObjectBase _
    Implements IAlterable, ICreatable, IDroppable, IScriptable
'Usage
Dim instance As FullTextIndexColumn

public sealed class FullTextIndexColumn : ScriptNameObjectBase, 
    IAlterable, ICreatable, IDroppable, IScriptable

public ref class FullTextIndexColumn sealed : public ScriptNameObjectBase, 
    IAlterable, ICreatable, IDroppable, IScriptable

[<SealedAttribute>]
type FullTextIndexColumn =  
    class 
        inherit ScriptNameObjectBase 
        interface IAlterable 
        interface ICreatable 
        interface IDroppable 
        interface IScriptable 
    end

public final class FullTextIndexColumn extends ScriptNameObjectBase implements IAlterable, ICreatable, IDroppable, IScriptable

The FullTextIndexColumn type exposes the following members.

Constructors

  Name Description
Public method FullTextIndexColumn() Initializes a new instance of the FullTextIndexColumn class.
Public method FullTextIndexColumn(FullTextIndex, String) Initializes a new instance of the FullTextIndexColumn class on the specified full-text index and with the specified name.

Top

Properties

  Name Description
Public property Language Gets or sets the language used by the full-text index column.
Public property Name Gets or sets the String which contains the name of the FullTextIndexColumn. (Overrides NamedSmoObject.Name.)
Public property Parent Gets or sets the FullTextIndex object that is the parent of the FullTextIndexColumn object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property StatisticalSemantics Gets or sets whether this column is included for statistical semantic queries.
Public property TypeColumnName Gets or sets the name of a column in the table that stores the document type.
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.)

Top

Methods

  Name Description
Public method Alter() Modifies the full text index column.
Public method Alter(Boolean) Modifies the full text index column.
Public method Create() Creates a full-text index column on the instance of Microsoft SQL Server as defined by the FullTextIndexColumn object.
Public method Create(Boolean) Creates a full-text index column on the instance of Microsoft SQL Server as defined by the FullTextIndexColumn object with the option to specify whether the full-text index is automatically populated after columns are added or removed.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop() Removes the full-text index column.
Public method Drop(Boolean) Removes the full-text index column with the option to specify whether the full-text index is automatically populated after columns are added or removed.
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 Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method Script() Generates a Transact-SQL script that can be used to re-create the full-text index column.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the full-text index column as specified by the script options.
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.)

Top

Remarks

To get the FullTextIndexColumn object properties, users can be a member of the public fixed server role.

To get the FullTextIndexColumn object properties, users must be a member of the sysadmin fixed server role or the db_owner or db_ddladmin fixed database roles.

To create or drop a full-text index column, users must be a member of the sysadmin fixed server role or the db_owner or db_ddladmin fixed database roles.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

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

Other Resources

CREATE FULLTEXT INDEX (Transact-SQL)