SearchProperty Class

The SearchProperty object represents a search property on a SQL Server database object.

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

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

Syntax

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

public sealed class SearchProperty : ScriptNameObjectBase, 
    ICreatable, IDroppable, IScriptable

public ref class SearchProperty sealed : public ScriptNameObjectBase, 
    ICreatable, IDroppable, IScriptable

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

public final class SearchProperty extends ScriptNameObjectBase implements ICreatable, IDroppable, IScriptable

The SearchProperty type exposes the following members.

Constructors

	Name	Description
	SearchProperty()	Initializes a new instance of the SearchProperty class.
	SearchProperty(SearchPropertyList, String)	Initializes a new instance of the SearchProperty class, specifying the parent SearchPropertyList and name.
	SearchProperty(SearchPropertyList, String, String, Int32, String)	Initializes a new instance of the SearchProperty class.

Top

Properties

	Name	Description
	Description	Gets or sets a String which contains the description of the SearchProperty.
	ID	Gets an Int32 representing the ID of the SearchProperty.
	IntID	Gets or Sets an Int32 representing the IntID of the SearchProperty.
	Name	Gets or sets a String which contains the name of the SearchProperty. (Overrides NamedSmoObject.Name.)
	Parent	Gets or sets the SearchPropertyList which contains the SearchProperty.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	PropertySetGuid	Gets the Guid of the property set associated with the SearchProperty.
	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.)

Top

Methods

	Name	Description
	Create	Creates a search property on the instance of SQL Server as defined by the Check object.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Drops the search property on the instance of SQL Server.
	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.)
	Refresh	Refreshes the script name. (Inherited from ScriptNameObjectBase.)
	Script()	Generates a Transact-SQL script that can be used to re-create the search property.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the search property, specifying the scripting options.
	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.)

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