ExtendedProperty クラス

定義

このクラスには、パッケージに関する追加情報を保持するメンバーが含まれます。

public ref class ExtendedProperty sealed : Microsoft::SqlServer::Dts::Runtime::DtsObject, IDisposable, Microsoft::SqlServer::Dts::Runtime::IDTSName, Microsoft::SqlServer::Dts::Runtime::IDTSPersist, System::ComponentModel::IComponent
public sealed class ExtendedProperty : Microsoft.SqlServer.Dts.Runtime.DtsObject, IDisposable, Microsoft.SqlServer.Dts.Runtime.IDTSName, Microsoft.SqlServer.Dts.Runtime.IDTSPersist, System.ComponentModel.IComponent
type ExtendedProperty = class
    inherit DtsObject
    interface IDTSPersist
    interface IDTSName
    interface IComponent
    interface IDisposable
Public NotInheritable Class ExtendedProperty
Inherits DtsObject
Implements IComponent, IDisposable, IDTSName, IDTSPersist
継承
ExtendedProperty
実装

注釈

ExtendedProperties コレクションを使用すると、カスタム情報をパッケージと共に保存できます。 たとえば、SSIS デザイナー自体は、パッケージ レイアウト情報を拡張プロパティに格納します。 パッケージのパッケージ拡張プロパティはデザイン時に非表示になり、実行時に無視されますが、パッケージと共に永続化され、ユーザー定義の情報またはメタデータをパッケージにアタッチして、自動化されたプロセスまたはカスタム ツールで使用できる便利な方法を提供します。

ExtendedProperty には、NameDescriptionDataType、および Value があります。 ExtendedPropertiesPackage プロパティを使用すると、その拡張プロパティのコレクションにアクセスし、コレクションの Add メソッドを使用して新しい拡張プロパティを追加できます。

プロパティ

CreationName

ランタイム エンジンが使用する文字列を返します。ランタイム エンジンは、この文字列を使用して ExtendedProperty オブジェクトのインスタンスを作成し、ExtendedProperties コレクションにこのオブジェクトを追加します。 このプロパティは読み取り専用です。

DataType

パッケージのこのインスタンスに格納されている値の DataType を取得します。 このフィールドは読み取り専用です。

Description

このインスタンスに格納されているプロパティに関連する説明を取得します。値の設定も可能です。

ID

このインスタンスの GUID を取得します。

Name

このインスタンスに格納されている情報の名前を取得します。値の設定も可能です。

Namespace

この情報に関連する名前空間を取得します。値の設定も可能です。

Site

プロパティのサイトを取得します。値の設定も可能です。

Value

このインスタンスに格納されている情報の値を取得します。値の設定も可能です。

メソッド

Dispose()

このクラスのインスタンスで使用されるリソースを解放します。

Equals(Object)

2 つのオブジェクト インスタンスが等しいかどうかを判断します。

(継承元 DtsObject)
GetHashCode()

このインスタンスのハッシュ コードを返します。

(継承元 DtsObject)
LoadFromXML(XmlNode, IDTSEvents)

このメソッドをアプリケーション コードから呼び出すことはできません。 .xml として保存されたパッケージを読み込むには、LoadPackage(String, IDTSEvents) メソッドを使用します。

SaveToXML(XmlDocument, XmlNode, IDTSEvents)

このメソッドをアプリケーション コードから呼び出すことはできません。 パッケージを .xml として保存するには、SaveToXml(String, Package, IDTSEvents) メソッドを使用します。

イベント

Disposed

破棄されたイベントをリッスンするイベント ハンドラーを追加します。

適用対象