ExtendedProperty 类
The ExtendedProperty object represents the extended properties that are defined for any object that has an ExtendedProperties collection property.
继承层次结构
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..::..ExtendedProperty
命名空间： Microsoft.SqlServer.Management.Smo
程序集： Microsoft.SqlServer.Smo（在 Microsoft.SqlServer.Smo.dll 中）
语法
声明
Public NotInheritable Class ExtendedProperty _
Inherits ScriptNameObjectBase _
Implements ICreatable, IAlterable, IDroppable, IMarkForDrop, _
IScriptable
用法
Dim instance As ExtendedProperty
public sealed class ExtendedProperty : ScriptNameObjectBase,
ICreatable, IAlterable, IDroppable, IMarkForDrop, IScriptable
public ref class ExtendedProperty sealed : public ScriptNameObjectBase,
ICreatable, IAlterable, IDroppable, IMarkForDrop, IScriptable
[<SealedAttribute>]
type ExtendedProperty =
class
inherit ScriptNameObjectBase
interface ICreatable
interface IAlterable
interface IDroppable
interface IMarkForDrop
interface IScriptable
end
public final class ExtendedProperty extends ScriptNameObjectBase implements ICreatable, IAlterable, IDroppable, IMarkForDrop, IScriptable
ExtendedProperty 类型公开以下成员。
构造函数
| 名称 | 说明 | |
|---|---|---|
.gif "公共方法") |
ExtendedProperty() () () () | Initializes a new instance of the ExtendedProperty class. |
|
ExtendedProperty(SqlSmoObject, String) | Initializes a new instance of the ExtendedProperty class with the specified parent and name. |
|
ExtendedProperty(SqlSmoObject, String, Object) | Initializes a new instance of the ExtendedProperty class with the specified parent, name, and value. |
页首
属性
| 名称 | 说明 | |
|---|---|---|
.gif "受保护属性") |
ExecuteForScalar | 获取或设置 Boolean 属性值，该值指定对象是否设置为针对标量选项执行。 （从 SqlSmoObject 继承。） |
|
IsTouched | 获取 Boolean 属性值，该值指定在服务器上对象属性是否已更新但尚未持久化。 （从 SqlSmoObject 继承。） |
.gif "公共属性") |
Name | Gets or sets the name of the object. （从 NamedSmoObject 继承。） |
|
ObjectInSpace | 获取 Boolean 属性值，该值指定对象是否单独存在，或者对象是否直接或间接连接到 SQL Server 的实例。 （从 SqlSmoObject 继承。） |
|
Parent | Gets or sets the SqlSmoObject object that is the parent of the ExtendedProperty object. |
|
Properties | 获取表示对象属性的 Property 对象的集合。 （从 SqlSmoObject 继承。） |
|
ScalarResult | 获取所引用对象的标量结果。 （从 SqlSmoObject 继承。） |
|
State | Gets the state of the referenced object. （从 SmoObjectBase 继承。） |
|
Urn | 获取唯一标识对象的统一资源名称 (URN) 地址值。 （从 SqlSmoObject 继承。） |
|
UserData | Gets or sets user-defined data associated with the referenced object. （从 SmoObjectBase 继承。） |
|
Value | Gets or sets the string value of the extended property. |
页首
方法
| 名称 | 说明 | |
|---|---|---|
.gif "受保护方法") |
AddDatabaseContext(StringCollection) | 将数据库上下文添加到 queries 参数标识的查询集合。 （从 SqlSmoObject 继承。） |
|
AddDatabaseContext(StringCollection, ScriptingOptions) | 将数据库上下文添加到 queries 参数标识的查询集合，并且使用指定的脚本选项。 （从 SqlSmoObject 继承。） |
|
Alter | Updates the extended property on the instance of Microsoft SQL Server with any property changes that have been made to the ExtendedProperty object that it represents. |
|
AlterImpl | 激活对象已更改事件。 （从 SqlSmoObject 继承。） |
|
AlterImplFinish | 在对象已更改事件完成时调用的方法。 （从 SqlSmoObject 继承。） |
|
AlterImplInit | 在对象已更改事件初始化时调用的方法。 （从 SqlSmoObject 继承。） |
|
AlterImplWorker | 调用 Alter 方法。 （从 SqlSmoObject 继承。） |
|
AppendCommaText | Appends text, optionally separated by a comma. （从 ScriptNameObjectBase 继承。） |
|
AppendWithCommaText | Appends text, optionally separated by a comma. （从 ScriptNameObjectBase 继承。） |
|
AppendWithOption | Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. （从 ScriptNameObjectBase 继承。） |
|
AutoGenerateName | Generates a name based on the object Guid. （从 ScriptNameObjectBase 继承。） |
|
BindDefaultImpl | 绑定由参数标识的默认项。 （从 SqlSmoObject 继承。） |
|
BindRuleImpl | 将规则架构绑定到由参数标识的规则和列。 （从 SqlSmoObject 继承。） |
|
CheckCollation | 按 collationName 参数标识的排序规则方法检查脚本选项的顺序。 （从 SqlSmoObject 继承。） |
|
CheckObjectDirty | Checks whether object has been modified and not persisted. （从 ScriptNameObjectBase 继承。） |
|
CheckObjectState() () () () | 验证所引用对象的状态。 （从 SqlSmoObject 继承。） |
|
CheckObjectState(Boolean) | 使用用来指定在尚未创建对象时引发异常的选项，验证所引用对象的状态。 （从 SqlSmoObject 继承。） |
|
CheckObjectStateImpl | 检查 SqlSmoObject 的状态。 （从 SqlSmoObject 继承。） |
|
CheckTextCorectness | Checks text for correctness against the parameters. （从 ScriptNameObjectBase 继承。） |
|
CheckTextModeSupport | Checks mode of support. （从 ScriptNameObjectBase 继承。） |
|
CheckVersion100 | 检查 SQL Server 的版本是否为 SQL Server 2008。 （从 SqlSmoObject 继承。） |
|
CheckVersion80 | 检查 SQL Server 2000 上对象的有效性。 （从 SqlSmoObject 继承。） |
|
CheckVersion80SP3 | 检查 SQL Server 2000 SP3 上对象的有效性。 （从 SqlSmoObject 继承。） |
|
CheckVersion90 | 检查 SQL Server 2005 上对象的有效性。 （从 SqlSmoObject 继承。） |
|
CheckVersionBelow90 | 检查 SQL Server 的版本是否在 SQL Server 2005 之前。 （从 SqlSmoObject 继承。） |
|
CleanObject | Cleans the referenced object. （从 ScriptNameObjectBase 继承。） |
|
Create | Creates an extended property on the instance of Microsoft SQL Server as defined by the ExtendedProperty object. |
|
CreateImpl | 使用脚本选项创建对象。 （从 SqlSmoObject 继承。） |
|
CreateImplFinish | 在创建事件完成时调用的方法。 （从 SqlSmoObject 继承。） |
|
CreateImplInit | 在创建事件初始化时调用的方法。 （从 SqlSmoObject 继承。） |
|
Discover | 发现 Object 类型的列表。 （从 SqlSmoObject 继承。） |
|
Drop | Drops the extended property that is represented by the ExtendedProperty object. |
|
DropImpl | 删除 SqlSmoObject。 （从 SqlSmoObject 继承。） |
|
DropImplWorker | 调用 drop 方法。 （从 SqlSmoObject 继承。） |
|
EnumScriptImpl | 枚举 so 参数指定的脚本。 （从 SqlSmoObject 继承。） |
|
EnumScriptImplWorker | 调用枚举 so 参数指定的脚本的方法。 （从 SqlSmoObject 继承。） |
|
EnumScriptImplWorkerSOChanged | 返回描述对象的脚本选项的 IEnumerable 字符串。 （从 SqlSmoObject 继承。） |
|
Equals | （从 Object 继承。） |
|
ExecuteNonQuery | （从 SqlSmoObject 继承。） |
|
Finalize | （从 Object 继承。） |
|
ForceTextModeOnTextBody | Enforces text mode on the text body. （从 ScriptNameObjectBase 继承。） |
|
FormatSqlVariant | 将对象格式化为 SqlVariant 类型。 （从 SqlSmoObject 继承。） |
|
GenerateDataSpaceFileStreamScript | 生成用于创建数据文件的脚本。 （从 SqlSmoObject 继承。） |
|
GenerateDataSpaceScript | 生成用于分配数据文件中的空间的脚本。 （从 SqlSmoObject 继承。） |
|
GetBindDefaultScript | 获取绑定 defSchema 和 defName 参数指定的默认值的脚本。 （从 SqlSmoObject 继承。） |
|
GetBindRuleScript | 获取指定绑定规则的脚本。 （从 SqlSmoObject 继承。） |
|
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | 对 SqlSmoObject 的布尔参数赋值。 （从 SqlSmoObject 继承。） |
|
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | 对 SqlSmoObject 的布尔属性赋值。 （从 SqlSmoObject 继承。） |
|
GetBraketNameForText | Gets the bracket name. （从 ScriptNameObjectBase 继承。） |
|
GetDateTimeParameter | 对 SqlSmoObject 的日期时间属性赋值。 （从 SqlSmoObject 继承。） |
|
GetDateTimeParameterAsInt | 为 SqlSmoObject 的日期时间属性赋一个整数值（如果该日期时间属性不为 Null）。 （从 SqlSmoObject 继承。） |
|
GetDBName | 获取与对象关联的数据库名称。 （从 SqlSmoObject 继承。） |
|
GetEnumParameter | 对 SqlSmoObject 的枚举属性赋值。 （从 SqlSmoObject 继承。） |
|
GetFragOptionString | 获取作为字符串值的 FragmentationOption 对象。 （从 SqlSmoObject 继承。） |
|
GetGuidParameter | 对 SqlSmoObject 的 Guid 属性赋值。 （从 SqlSmoObject 继承。） |
|
GetHashCode | （从 Object 继承。） |
|
GetIsSystemNamed | Gets a Boolean value that specifies whether the system is named. （从 ScriptNameObjectBase 继承。） |
|
GetIsTextDirty | Determines whether the text value is consistent with stored value. （从 ScriptNameObjectBase 继承。） |
|
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | 对 SqlSmoObject 的参数赋值。 （从 SqlSmoObject 继承。） |
|
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | 对 SqlSmoObject 的参数赋值。 （从 SqlSmoObject 继承。） |
|
GetPropValue | 获取 SqlSmoObject 对象的属性值。 （从 SqlSmoObject 继承。） |
|
GetPropValueOptional | 获取 SqlSmoObject 对象的属性值。 （从 SqlSmoObject 继承。） |
|
GetPropValueOptionalAllowNull | 获取 SqlSmoObject 对象的属性值。 （从 SqlSmoObject 继承。） |
|
GetRealValue | 获取 SqlSmoObject 对象的属性值。 （从 SqlSmoObject 继承。） |
|
GetScriptIncludeExists | Gets the script including the test for existence of type being scripted. （从 ScriptNameObjectBase 继承。） |
|
GetScriptingOptionsForCreate | 获取 SqlSmoObject 对象的 ScriptingOptions。 （从 SqlSmoObject 继承。） |
|
GetServerName | 获取对象与之关联的 SQL Server 实例的名称。 （从 SqlSmoObject 继承。） |
|
GetServerObject | 获取 SqlSmoObject 对象的服务器。 （从 SqlSmoObject 继承。） |
|
GetSqlServerVersionName | 获取对象与之关联的 SQL Server 实例的版本名称。 （从 SqlSmoObject 继承。） |
|
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | 对 SqlSmoObject 对象的字符串参数赋值。 （从 SqlSmoObject 继承。） |
|
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | 对 SqlSmoObject 对象的字符串参数赋值。 （从 SqlSmoObject 继承。） |
|
GetTextBody() () () () | Returns the text body. （从 ScriptNameObjectBase 继承。） |
|
GetTextBody(Boolean) | Returns the text body. （从 ScriptNameObjectBase 继承。） |
|
GetTextForScript(ScriptingOptions, Boolean, array<String> [] () [] []) | Gets the text for scripting. （从 ScriptNameObjectBase 继承。） |
|
GetTextForScript(ScriptingOptions, Boolean, array<String> [] () [] [], Boolean) | Gets the text of script object. （从 ScriptNameObjectBase 继承。） |
|
GetTextHeader | Returns the text header. （从 ScriptNameObjectBase 继承。） |
|
GetTextMode | Determines whether the script name is using text mode. （从 ScriptNameObjectBase 继承。） |
|
GetTextProperty(String) | Gets the property as text. （从 ScriptNameObjectBase 继承。） |
|
GetTextProperty(String, ScriptingOptions) | Gets the property as text. （从 ScriptNameObjectBase 继承。） |
|
GetTimeSpanParameterAsInt | 对 SqlSmoObject 对象的时间范围参数赋值。 （从 SqlSmoObject 继承。） |
|
GetType | （从 Object 继承。） |
|
GetUrnRecursive(StringBuilder) | 对 SqlSmoObject 对象的 Urn 对象赋值。 （从 SqlSmoObject 继承。） |
|
GetUrnRecursive(StringBuilder, UrnIdOption) | 对 SqlSmoObject 对象的 Urn 对象赋值。 （从 SqlSmoObject 继承。） |
|
ImplInitialize | 初始化 SqlSmoObject 对象的字段。 （从 SqlSmoObject 继承。） |
|
Initialize() () () () | 初始化对象并强制加载属性。 （从 SqlSmoObject 继承。） |
|
Initialize(Boolean) | 初始化对象并强制加载属性。 （从 SqlSmoObject 继承。） |
|
IsObjectDirty | Determines whether the referenced object is consistent with the stored object. （从 ScriptNameObjectBase 继承。） |
|
IsObjectInitialized | 验证对象是否已初始化。 （从 SqlSmoObject 继承。） |
|
IsObjectInSpace | 验证对象是单独存在还是连接到 SQL Server 的实例。 （从 SqlSmoObject 继承。） |
|
IsVersion80SP3 | 确定 SQL Server 的版本是否为 SQL Server 2000 SP3。 （从 SqlSmoObject 继承。） |
|
IsVersion90AndAbove | 确定 SQL Server 的版本是否为 SQL Server 2005 或更高版本。 （从 SqlSmoObject 继承。） |
|
MarkDropped | 将 SqlSmoState 设置为删除。 （从 SqlSmoObject 继承。） |
|
MarkForDrop | Marks the object so that it will be dropped the next time the Alter method is called for its parent object. |
|
MarkForDropImpl | 将 SqlSmoState 设置为删除。 （从 SqlSmoObject 继承。） |
|
MemberwiseClone | （从 Object 继承。） |
|
PostAlter | 在更改 SqlSmoObject 后激活的方法。 （从 SqlSmoObject 继承。） |
|
PostCreate | 在创建 SqlSmoObject 后激活的方法。 （从 SqlSmoObject 继承。） |
|
PostDrop | 在删除 SqlSmoObject 后激活的方法。 （从 SqlSmoObject 继承。） |
|
Refresh | Refreshes the script name. （从 ScriptNameObjectBase 继承。） |
|
RenameImpl | 标识为仅供参考。不提供支持。不保证以后的兼容性。 （从 NamedSmoObject 继承。） |
|
RenameImplWorker | 标识为仅供参考。不提供支持。不保证以后的兼容性。 （从 NamedSmoObject 继承。） |
|
Script() () () () | Generates a Transact-SQL script that can be used to re-create the extended property. |
|
Script(ScriptingOptions) | Generates a Transact-SQL script that can be used to re-create the extended property as specified by the script options. |
|
ScriptAlter | 根据参数更改 SqlSmoObject。 （从 SqlSmoObject 继承。） |
|
ScriptAnsiQI | Scripts the database object in ANSI text. （从 ScriptNameObjectBase 继承。） |
|
ScriptChangeOwner | This method supports the SMO infrastructure and is not intended to be used directly from your code. （从 NamedSmoObject 继承。） |
|
ScriptCreate | 根据参数更改 SqlSmoObject。 （从 SqlSmoObject 继承。） |
|
ScriptDdl | 引发 InvalidSmoOperationException。 （从 SqlSmoObject 继承。） |
|
ScriptDrop | 引发 InvalidSmoOperationException。 （从 SqlSmoObject 继承。） |
|
ScriptImpl() () () () | 获取 SqlSmoObject 脚本的集合。 （从 SqlSmoObject 继承。） |
|
ScriptImpl(ScriptingOptions) | 获取 SqlSmoObject 脚本的集合。 （从 SqlSmoObject 继承。） |
|
ScriptImplWorker | 获取 SqlSmoObject 脚本的集合。 （从 SqlSmoObject 继承。） |
|
ScriptInformativeHeaders | Scripts the information headers. （从 ScriptNameObjectBase 继承。） |
|
ScriptOwner | Alters the script owner authorization. （从 NamedSmoObject 继承。） |
|
ScriptRename | This method supports the SMO infrastructure and is not intended to be used directly from your code. （从 NamedSmoObject 继承。） |
|
SetCollectionTextMode | Sets the collection text mode. （从 ScriptNameObjectBase 继承。） |
|
SetIsSystemNamed | Sets a Boolean value that specifies whether the system is named. （从 ScriptNameObjectBase 继承。） |
|
SetParentImpl | 将 SqlSmoObject 的父级设置为 newParent 参数。 （从 SqlSmoObject 继承。） |
|
SetSchemaOwned | Sets the schema owned value. （从 NamedSmoObject 继承。） |
|
SetTextBody | Specifies the text body. （从 ScriptNameObjectBase 继承。） |
|
SetTextHeader | Specifies the text header. （从 ScriptNameObjectBase 继承。） |
|
SetTextMode | Specifies the text mode. （从 ScriptNameObjectBase 继承。） |
|
SwitchTextMode | Switches the text mode. （从 ScriptNameObjectBase 继承。） |
|
ThrowIfTextIsDirtyForAlter | Throws an exception of text has been modified and not persisted. （从 ScriptNameObjectBase 继承。） |
|
ToString | 返回表示所引用对象的 String。 （从 SqlSmoObject 继承。） |
|
TouchImpl | 未实现。 （从 SqlSmoObject 继承。） |
|
UnbindDefaultImpl | 取消绑定 SqlSmoObject 的默认列。 （从 SqlSmoObject 继承。） |
|
UnbindRuleImpl | 取消绑定 SqlSmoObject 的规则。 （从 SqlSmoObject 继承。） |
|
Validate | Validates the state of an object. （从 SmoObjectBase 继承。） |
页首
事件
| 名称 | 说明 | |
|---|---|---|
.gif "公共事件") |
PropertyChanged | 表示更改属性时发生的事件。 （从 SqlSmoObject 继承。） |
|
PropertyMetadataChanged | 表示属性元数据更改时发生的事件。 （从 SqlSmoObject 继承。） |
页首
字段
| 名称 | 说明 | |
|---|---|---|
.gif "受保护字段") |
m_ExtendedProperties | 表示一个属性，可以对该属性进行定义以便扩展 SqlSmoObject 提供的属性。 （从 SqlSmoObject 继承。） |
|
singletonParent | 表示单一父级。 （从 SqlSmoObject 继承。） |
页首
显式接口实现
| 名称 | 说明 | |
|---|---|---|
.gif "显式接口实现") .gif "私有方法") |
IAlienObject. . :: . .Discover | 发现任何依赖关系。不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。） |
|
IAlienObject. . :: . .GetDomainRoot | 返回域的根。 （从 SqlSmoObject 继承。） |
|
IAlienObject. . :: . .GetParent | 获取此对象的父对象。不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。） |
|
IAlienObject. . :: . .GetPropertyType | 获取指定属性的类型。 （从 SqlSmoObject 继承。） |
|
IAlienObject. . :: . .GetPropertyValue | 获取指定属性的值。 （从 SqlSmoObject 继承。） |
|
IAlienObject. . :: . .GetUrn | 获取对象的统一资源名称。不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。） |
|
IAlienObject. . :: . .Resolve | 获取一个实例，该实例包含与来自该对象的统一资源名称的对象有关的信息。 （从 SqlSmoObject 继承。） |
|
IAlienObject. . :: . .SetObjectState | 将对象状态设置为指定的 SfcObjectState 值。 （从 SqlSmoObject 继承。） |
|
IAlienObject. . :: . .SetPropertyValue | 设置属性值。 （从 SqlSmoObject 继承。） |
|
ISfcPropertyProvider. . :: . .GetPropertySet | 获取对此对象的属性集的接口引用。不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 （从 SqlSmoObject 继承。） |
页首
注释
Thread Safety
此类型的任何公共静态（Microsoft Visual Basic 中的 Shared）成员在多线程操作中是安全的。不保证所有实例成员都是线程安全的。
线程安全
此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。