FullTextStopList Class

  • Article

The FullTextStopList object represents a full-text stop list.

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.FullTextStopList

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

Syntax

'Declaration
<PhysicalFacetAttribute> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class FullTextStopList _
    Inherits ScriptNameObjectBase _
    Implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable,  _
    IScriptable
'Usage
Dim instance As FullTextStopList

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class FullTextStopList : ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IScriptable

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class FullTextStopList sealed : public ScriptNameObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IScriptable

[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type FullTextStopList =  
    class 
        inherit ScriptNameObjectBase 
        interface ISfcSupportsDesignMode 
        interface IObjectPermission 
        interface ICreatable 
        interface IDroppable 
        interface IScriptable 
    end

public final class FullTextStopList extends ScriptNameObjectBase implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IScriptable

The FullTextStopList type exposes the following members.

Constructors

  Name Description
Public method FullTextStopList() Initializes a new default instance of the FullTextStopList class.
Public method FullTextStopList(Database, String) Initializes a new instance of the FullTextStopList class that has the specified name and database.

Top

Properties

  Name Description
Public property ID Gets the ID value that uniquely identifies the full-text stop list.
Public property Name Gets or sets the String which contains the name of the FullTextStopList. (Overrides NamedSmoObject.Name.)
Public property Owner Gets or sets the name of the owner of the full-text stop list.
Public property Parent Gets or sets the parent of the FullTextIndex 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 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 AddStopWord Adds a stopword to the stop list for the full-text index.
Public method Create Creates a full text stop list on the instance of SQL Server as defined by the FullTextStopList object.
Public method CreateFromExistingStopList(String) Creates a full-text stop list on the instance of SQL Server from the specified stop list.
Public method CreateFromExistingStopList(String, String) Creates a full text stop list on the instance of SQL Server from the specified stop list on the specified database.
Public method CreateFromSystemStopList Creates a new stop list from the system default stop list.
Public method Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the full-text stop list.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the full-text stop list.
Public method Deny(ObjectPermissionSet, String, Boolean) Denies the specified set of permissions for the specified grantee and the other users to whom the grantee granted the specified set of permissions on the full-text stop list.
Public method Deny(ObjectPermissionSet, array<String[], Boolean) Denies the specified set of permissions for the specified grantees and the other users to whom the grantees granted the specified set of permissions on the full-text stop list.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the full-text stop list from the database.
Public method EnumObjectPermissions() Enumerates a list of object permissions for the table.
Public method EnumObjectPermissions(String) Enumerates a list of object permissions for a specified grantee on the full-text stop list.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of object permissions for the specified permission on the full-text stop list.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of object permissions for a specified grantee and a specified permission on the full-text stop list.
Public method EnumStopWords Creates a DataTable containing the stop words for this instance.
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 Grant(ObjectPermissionSet, String) Grants the specified set of permissions to the specified grantee on the full-text stop list.
Public method Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the full-text stop list.
Public method Grant(ObjectPermissionSet, String, Boolean) Grants access to the specified permission and the ability to grant access to other uses for the specified grantee on the full-text stop list.
Public method Grant(ObjectPermissionSet, array<String[], Boolean) Grants access to the specified permission and the ability to grant access to other uses for the specified grantees on the full-text stop list.
Public method Grant(ObjectPermissionSet, String, Boolean, String) Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the full-text stop list under an assumed role.
Public method Grant(ObjectPermissionSet, array<String[], Boolean, String) Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the full-text stop list under an assumed role.
Public method HasStopWord Verifies that the specified stopword with the specified language is present in the full-text stop list.
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 RemoveAllStopWords() Removes all stopwords from the full-text stoplist.
Public method RemoveAllStopWords(String) Removes all stopwords with the specified language from the full-text stop list.
Public method RemoveStopWord Removes the specified stopword with the specified language from the full-text stoplist.
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the full-text stop list.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the full-text stop list.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revokes a previously granted set of permissions from a grantee on the full-text stop list and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean) Revokes a previously granted set of permissions from a list of grantees on the full-text stop list and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) Revokes a previously granted set of permissions from a grantee from the full-test stop list and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String) Revokes a previously granted set of permissions from a list of grantees from the full-test stop list and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
Public method Script() Generates a Transact-SQL script that can be used to re-create the full-text stop list.
Public method Script(ScriptingOptions) Generates a Transact-SQL script with the specified scripting options that can be used to re-create the full-text stop list.
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 a Boolean value that indicates whether the object supports design mode.

Top

Remarks

Full-text stop lists contain a list of words, called stopwords, that will be excluded from full-text indexes. For more information about stopwords and stoplists, see Configure and Manage Stopwords and Stoplists for Full-Text Search.

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.

Examples

Handling SMO Events

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