ExtendedProperty クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
このクラスには、パッケージに関する追加情報を持つメンバーが含まれます。
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
- 継承
- 実装
注釈
ExtendedPropertiesコレクションはカスタム情報をパッケージに保存することを可能にします。 例えば、SSISデザイナー自体は拡張プロパティにパッケージレイアウト情報を保存しています。 パッケージの拡張プロパティは設計時には隠され、実行時には無視されますが、パッケージに永続化され、ユーザー定義の情報やメタデータをパッケージに付けて自動化プロセスやカスタムツールで利用可能となる便利な方法を提供します。
各 ExtendedProperty には Name、 Description、 DataType、 Valueがあります。 Packageの拡張プロパティコレクションにアクセスするにはExtendedPropertiesプロパティを使用し、コレクションの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 |
Disposedイベントを聞くイベントハンドラーを追加します。 |