Connection クラス

定義

名前空間:

DocumentFormat.OpenXml.Spreadsheet

アセンブリ:

DocumentFormat.OpenXml.dll

パッケージ:

DocumentFormat.OpenXml v3.0.1

繋がり。

このクラスは、Office 2007 以降で使用できます。

オブジェクトを xml としてシリアル化されるときに、修飾名は x:connection です。

public class Connection : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Connection = class
    inherit OpenXmlCompositeElement

Public Class Connection
Inherits OpenXmlCompositeElement

継承

Object

OpenXmlElement

OpenXmlCompositeElement

Connection

注釈

[ISO/IEC 29500-1 1st Edition]

connection (Connection)

この要素には、外部データ ソースで取得する方法の定義と、ブック内での接続の使用方法を説明する情報の両方が含まれています。 OLAP 数式、QueryTables、ピボットテーブルなどのワークシート内の特定のコンストラクトでは、接続内の情報を使用して、既定のイベントまたはユーザーの明示的な要求に基づいてデータを取得または更新します。

親の要素
connections (§18.13.2)

子要素	Subclause
dbPr (データベース プロパティ)	§18.13.3
extLst (Future Feature Data Storage Area)	§18.2.10
olapPr (OLAP プロパティ)	§18.13.5
parameters (クエリ パラメーター)	§18.13.7
textPr (テキスト インポート設定)	§18.13.12
webPr (Web クエリプロパティ)	§18.13.13

属性	説明
background (Background Refresh)	接続をバックグラウンドで (非同期的に) 更新できるかどうかを示します。 接続 の推奨される使用法がバックグラウンドで非同期的に更新される場合は true。 接続 の推奨される使用法がフォアグラウンドで同期的に更新される場合は false。 このフラグは、特定のケースでは意図的に無視する必要があります。 [例: フラグが無視される場合の例は、Microsoft SQL Server Analysis Services 上の OLAP データへの接続の場合です。この接続はピボットテーブルとブック内の CUBE 関数の両方で使用されます。 その接続は常にピボットテーブルによって同期的に更新され、常に CUBE 関数によって非同期的に更新されます。 例終わり] この属性で使用できる値は、W3C XML スキーマの boolean データ型で定義されています。
credentials (再接続方法)	接続を確立 (または再確立) するときに使用する認証方法を指定します。 この属性に使用できる値は、 ST_CredMethod 単純型 (§18.18.16) によって定義されます。
deleted (削除された接続)	関連付けられているブック接続が削除されたかどうかを示します。 接続 が削除されている場合は true。それ以外の場合は false。 削除された接続には属性名と deleted=true のみが含まれており、他のすべての情報は SpreadsheetML ファイルから削除されます。 削除された接続と同じ名前で新しい接続が作成された場合、削除された接続は新しい接続によって上書きされます。 この属性で使用できる値は、W3C XML スキーマの boolean データ型で定義されています。
description (接続の説明)	この接続のユーザー説明を指定します。 この属性に使用できる値は、 ST_Xstring 単純型 (§22.9.2.19) によって定義されます。
id (接続 ID)	この接続の一意識別子を指定します。 この属性に指定できる値は、W3C XML スキーマの unsignedInt データ型で定義されます。
interval (自動更新間隔)	接続の自動更新の間隔を分単位で指定します。 この属性が存在しない場合、接続は自動的に更新されません。 この属性に指定できる値は、W3C XML スキーマの unsignedInt データ型で定義されます。
keepAlive (接続を開いたままにする)	true の 場合、スプレッドシート アプリケーションは接続を開いたままにしておく必要があります。 false の場合、アプリケーションは情報を取得した後に接続を閉じる必要があります。 これは、PivotCache オブジェクトの MaintainConnection プロパティに対応します。 この属性で使用できる値は、W3C XML スキーマの boolean データ型で定義されています。
minRefreshableVersion (更新に必要な最小バージョン)	従来のスプレッドシート アプリケーションとの互換性のために。 これは、データ接続を正しく更新するために必要な最小バージョン # を表します。 この属性は、QueryTable によって使用される接続に適用されます。 この属性に使用できる値は、W3C XML スキーマ unsignedByte データ型によって定義されます。
name (接続名)	接続の名前を指定します。 各接続には、一意の名前を付ける必要があります。 接続が削除済みとしてマークされ、同じ名前で新しい接続が追加されると、削除された接続が新しい接続に置き換えられます。 この属性に使用できる値は、 ST_Xstring 単純型 (§22.9.2.19) によって定義されます。
new (新しい接続)	接続 が初めて更新されていない場合は true。それ以外の場合は false。 この状態は、クエリの戻りが完了する前にユーザーがファイルを保存するときに発生する可能性があります。 この属性で使用できる値は、W3C XML スキーマの boolean データ型で定義されています。
odcFile (接続ファイル)	この接続が作成された外部接続ファイルへの完全パスを指定します。 データの更新試行中に接続が失敗し、再接続Method=1 の場合、スプレッドシート アプリケーションはブックに埋め込まれた接続オブジェクトではなく、外部接続ファイルの情報を使用して再試行します。 これは、データ ソースと spreadsheetML ドキュメント管理の利点です。 外部接続ファイルの定義が変更された場合 (データベース サーバー名の変更など)、その接続を使用したブックは内部接続情報で接続に失敗し、このファイルから新しい接続情報を再読み込みします。 ユーザーがブック内の接続定義を手動で編集すると、この属性はスプレッドシート アプリケーションによってクリアされます。 またはシステム固有のファイル パス表記で表すことができます。 [注: アプリケーションは、サポートする形式と、システム固有のファイル パス表記がサポートされているかどうかを決定できます。 メモの終了] この属性に使用できる値は、 ST_Xstring 単純型 (§22.9.2.19) によって定義されます。
onlyUseConnectionFile (接続ファイルのみを使用)	スプレッドシート アプリケーションが常に、接続の更新時に odcFile 属性によって示される外部接続ファイル内の接続情報のみを使用する必要があるかどうかを示します。 false の場合、スプレッドシート アプリケーションは、次に説明する reconnectionMethod 属性によって示される手順に従う必要があります。 OLE DB 接続と ODBC 接続にのみ適用されます。この属性は他の種類の接続では無視されます。 この属性で使用できる値は、W3C XML スキーマの boolean データ型で定義されています。
reconnectionMethod (Reconnection メソッド)	接続が失敗したときにスプレッドシート アプリケーションが実行する処理を指定します。 値は、次のとおりです。 1 = 必要に応じて:更新時に既存の接続情報を使用します。 既存の情報を使用して接続を確立できない場合は、外部接続ファイルから更新された接続情報 (使用可能な場合) を取得します。 2 = 常に: 更新するたびに、外部接続ファイルから更新された接続情報を取得し(使用可能な場合)、既存の接続情報の代わりに使用します。 この場合、外部接続ファイルが使用できない場合、データ更新は失敗します。 3 = Never: 外部接続ファイルが使用可能であっても、既存の接続情報を使用できない場合でも、更新された接続情報を取得しないでください。 この属性に指定できる値は、W3C XML スキーマの unsignedInt データ型で定義されます。
refreshedVersion (最終更新バージョン)	下位互換性のために、この属性は、最後に接続を更新したスプレッドシート アプリケーションのバージョンを示します。 この属性は、クエリ テーブルによって使用される接続に適用されます。 この属性に使用できる値は、W3C XML スキーマ unsignedByte データ型によって定義されます。
refreshOnLoad (開いている場合の更新)	ファイルを開くときにこの接続を更新する必要がある場合は true。それ以外の場合は false。 この属性で使用できる値は、W3C XML スキーマの boolean データ型で定義されています。
saveData (データの保存)	テーブル を設定するために接続を介してフェッチされた外部データがブックと共に保存される場合は true。それ以外の場合は false。 これはデータ セキュリティの目的で存在します。ブックに外部データが保存されていない (または "キャッシュ" されている) 場合は、関連するデータを取得するたびに現在のユーザー資格情報が必要になり、ブック作成者がファイルを保存する前に最後に使用していたデータがユーザーに表示されません。 この属性で使用できる値は、W3C XML スキーマの boolean データ型で定義されています。
savePassword (パスワードの保存)	パスワードを接続文字列の一部として保存する場合は true、それ以外の場合は False。 この属性で使用できる値は、W3C XML スキーマの boolean データ型で定義されています。
singleSignOnId (SSO Id)	中間 spreadsheetML サーバーと外部データ ソース間の認証に使用されるシングル サインオン (SSO) の識別子。 [注: データ接続では、さまざまなテクノロジを使用できます。 この属性に格納される潜在的な値の 1 つの例は、 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/spptsdk/html/cSSOReturnCodes_SV01001109.aspend note] にあります。 この属性に使用できる値は、 ST_Xstring 単純型 (§22.9.2.19) によって定義されます。
sourceFile (ソース データベース ファイル)	外部データ ソースがファイル ベースの場合に使用されます。 このようなデータ ソースへの接続が失敗すると、スプレッドシート アプリケーションはこのファイルに直接接続しようとします。 またはシステム固有のファイル パス表記で表すことができます。 [注: アプリケーションは、サポートする形式と、システム固有のファイル パス表記がサポートされているかどうかを決定できます。 メモの終了] この属性に使用できる値は、 ST_Xstring 単純型 (§22.9.2.19) によって定義されます。
type (データベース ソースの種類)	データ ソースの種類を指定します。 値は以下のとおりです。 1. ODBC ベースのソース 2. DAO ベースのソース 3. ファイル ベースのデータベース ソース 4. Web クエリ 5. OLE DB ベースのソース 6. テキストベースのソース 7. レコード セット 8. DSP この属性に指定できる値は、W3C XML スキーマの unsignedInt データ型で定義されます。

[注: この要素のコンテンツ モデル (CT_Connection) の W3C XML スキーマ定義は§A.2 にあります。 メモの終了]

ISO/IEC29500: 2008。

コンストラクター

Connection()	Connection クラスの新しいインスタンスを初期化します。
Connection(IEnumerable<OpenXmlElement>)	指定した子要素を使用して、Connection クラスの新しいインスタンスを初期化します。
Connection(OpenXmlElement[])	指定した子要素を使用して、Connection クラスの新しいインスタンスを初期化します。
Connection(String)	外部 XML から Connection クラスの新しいインスタンスを初期化します。

プロパティ

Background	背景 スキーマ内の次の属性を表します。
ChildElements	現在の要素のすべての子ノードを取得します。 (継承元 OpenXmlElement)
ConnectionExtensionList	ConnectionExtensionList。 スキーマの x:extLst 要素タグを表します。
ConnectionFile	odcFile スキーマ内の次の属性を表します: odcFile
Credentials	資格 情報 スキーマ内の次の属性を表します: 資格情報
DatabaseProperties	DatabaseProperties。 スキーマ内の x:dbPr 要素タグを表します。
Deleted	deleted スキーマ内の次の属性を表します。削除済み
Description	説明 スキーマ内の次の属性を表します: description
ExtendedAttributes	現在の要素のすべての拡張属性 (スキーマで定義されていない属性) を取得します。 (継承元 OpenXmlElement)
Features	現在の要素の を IFeatureCollection 取得します。 この機能コレクションは読み取り専用ですが、使用可能な場合は親パーツとパッケージから機能を継承します。 (継承元 OpenXmlElement)
FirstChild	現在の OpenXmlElement 要素の最初の子を取得します。 (継承元 OpenXmlCompositeElement)
HasAttributes	現在の要素に属性があるかどうかを示す値を取得します。 (継承元 OpenXmlElement)
HasChildren	現在の要素に子要素があるかどうかを示す値を取得します。 (継承元 OpenXmlCompositeElement)
Id	id スキーマ内の次の属性を表します: id
InnerText	現在のノードとそのすべての子の連結値を取得または設定します。 (継承元 OpenXmlCompositeElement)
InnerXml	現在のノードの子ノードのみを表すマークアップを取得または設定します。 (継承元 OpenXmlCompositeElement)
Interval	interval スキーマ内の次の属性を表します: interval
KeepAlive	Keepalive スキーマ内の次の属性を表します。keepAlive
LastChild	現在の OpenXmlElement 要素の最後の子を取得します。 このような OpenXmlElement 要素がない場合は、null (Visual Basic では Nothing) を返します。 (継承元 OpenXmlCompositeElement)
LocalName	現在の要素のローカル名を取得します。 (継承元 OpenXmlElement)
MCAttributes	マークアップ互換性属性を取得または設定します。 現在の要素に対してマークアップ互換性属性が定義されていない場合は null を返します。 (継承元 OpenXmlElement)
MinRefreshableVersion	minRefreshableVersion スキーマ内の次の属性を表します。 minRefreshableVersion
Name	name スキーマ内の次の属性を表します。
NamespaceDeclarations	現在の要素で定義されているすべての名前空間宣言を取得します。 名前空間宣言がない場合は、空の列挙子を返します。 (継承元 OpenXmlElement)
NamespaceUri	現在の要素の名前空間 URI を取得します。 (継承元 OpenXmlElement)
New	新機能 スキーマ内の次の属性を表します。new
OlapProperties	OlapProperties。 スキーマ内の x:olapPr 要素タグを表します。
OnlyUseConnectionFile	onlyUseConnectionFile スキーマ内の次の属性を表します。onlyUseConnectionFile
OpenXmlElementContext	現在の要素の OpenXmlElementContext を取得します。 (継承元 OpenXmlElement)
OuterXml	現在の要素とそのすべての子要素を表すマークアップを取得します。 (継承元 OpenXmlElement)
Parameters	パラメーター。 スキーマの要素タグ x:parameters を表します。
Parent	現在の要素の親要素を取得します。 (継承元 OpenXmlElement)
Prefix	現在の要素の名前空間プレフィックスを取得します。 (継承元 OpenXmlElement)
ReconnectionMethod	reconnectionMethod スキーマ内の次の属性を表します:reconnectionMethod
RefreshedVersion	refreshedVersion スキーマ内の次の属性を表します: refreshedVersion
RefreshOnLoad	refreshOnLoad スキーマ内の次の属性を表します:refreshOnLoad
SaveData	saveData スキーマ内の次の属性を表します。saveData
SavePassword	savePassword スキーマ内の次の属性を表します。savePassword
SingleSignOnId	singleSignOnId スキーマ内の次の属性を表します: singleSignOnId
SourceFile	sourceFile スキーマ内の次の属性を表します: sourceFile
TextProperties	TextProperties。 スキーマの x:textPr 要素タグを表します。
Type	type スキーマ内の次の属性を表します。 型
WebQueryProperties	WebQueryProperties。 スキーマ内の x:webPr 要素タグを表します。
XmlQualifiedName	現在の要素の修飾名を取得します。 (継承元 OpenXmlElement)
XName	現在の要素の修飾名を取得します。 (継承元 OpenXmlElement)

メソッド

AddAnnotation(Object)	現在の OpenXmlElement 要素の注釈の一覧にオブジェクトを追加します。 (継承元 OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	指定した要素が既知の子である場合は、 要素に追加します。 これにより、 要素がスキーマに従って正しい場所に追加されます。 (継承元 OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	現在のノードに名前空間宣言を追加します。 (継承元 OpenXmlElement)
Ancestors()	現在の要素のすべての先祖を列挙します。 (継承元 OpenXmlElement)
Ancestors<T>()	指定した型を持つ現在の要素の先祖のみを列挙します。 (継承元 OpenXmlElement)
Annotation(Type)	現在の OpenXmlElement 要素から、指定した型の最初の注釈オブジェクトを取得します。 (継承元 OpenXmlElement)
Annotation<T>()	現在の OpenXmlElement 要素から、指定した型の最初の注釈オブジェクトを取得します。 (継承元 OpenXmlElement)
Annotations(Type)	現在の OpenXmlElement 要素の指定した型を持つ注釈のコレクションを取得します。 (継承元 OpenXmlElement)
Annotations<T>()	現在の OpenXmlElement 要素の指定した型を持つ注釈のコレクションを取得します。 (継承元 OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	要素のリストから現在の要素の子要素のリストの末尾に各要素を追加します。 (継承元 OpenXmlElement)
Append(OpenXmlElement[])	要素の配列から、現在の要素の子要素のリストの末尾に各要素を追加します。 (継承元 OpenXmlElement)
AppendChild<T>(T)	現在の要素の子ノードのリストの末尾に、指定した要素を追加します。 (継承元 OpenXmlCompositeElement)
ClearAllAttributes()	既知の属性と拡張属性の両方を含むすべての属性をクリアします。 (継承元 OpenXmlElement)
Clone()	現在のノードの複製を作成します。 (継承元 OpenXmlElement)
CloneNode(Boolean)	このノードの複製を作成します。
Descendants()	現在の要素のすべての子孫を列挙します。 (継承元 OpenXmlElement)
Descendants<T>()	T 型のすべての現在の要素の子孫を列挙します。 (継承元 OpenXmlElement)
Elements()	現在の要素のすべての子を列挙します。 (継承元 OpenXmlElement)
Elements<T>()	指定した型を持つ現在の要素の子のみを列挙します。 (継承元 OpenXmlElement)
ElementsAfter()	現在の要素に続き、現在の要素と同じ親を持つすべての兄弟要素を列挙します。 (継承元 OpenXmlElement)
ElementsBefore()	現在の要素の前にあり、現在の要素と同じ親を持つすべての兄弟要素を列挙します。 (継承元 OpenXmlElement)
GetAttribute(String, String)	指定したタグ名と名前空間 URI を持つ Open XML 属性を取得します。 (継承元 OpenXmlElement)
GetAttributes()	すべての属性のコピーを含むリストを取得します。 (継承元 OpenXmlElement)
GetEnumerator()	子コレクションを反復処理する列挙子を返します。 (継承元 OpenXmlElement)
GetFirstChild<T>()	T 型の最初の子要素を検索します。 (継承元 OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	指定した参照要素の直後に、指定した要素を挿入します。 (継承元 OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	現在の要素の直後に、指定した要素を挿入します。 (継承元 OpenXmlElement)
InsertAt<T>(T, Int32)	現在の要素の子の指定したインデックス位置に、指定した要素を挿入します。 (継承元 OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	指定した参照要素の直前に、指定した要素を挿入します。 (継承元 OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	現在の要素の直前に、指定した要素を挿入します。 (継承元 OpenXmlElement)
IsAfter(OpenXmlElement)	指定した要素の後に現在の要素がドキュメントの順序で表示されるかどうかを判断します。 (継承元 OpenXmlElement)
IsBefore(OpenXmlElement)	指定した要素の前に現在の要素がドキュメントの順序で表示されるかどうかを判断します。 (継承元 OpenXmlElement)
LookupNamespace(String)	現在のノードのコンテキストの名前空間プレフィックスを解決します。 (継承元 OpenXmlElement)
LookupPrefix(String)	現在の要素スコープ内の名前空間 URI の対応するプレフィックスを検索します。 (継承元 OpenXmlElement)
NextSibling()	現在の OpenXmlElement 要素の直後にある OpenXmlElement 要素を取得します。 次の OpenXmlElement 要素がない場合は null (Visual Basic では Nothing) を返します。 (継承元 OpenXmlElement)
NextSibling<T>()	現在の OpenXmlElement 要素に続く指定した型を持つ OpenXmlElement 要素を取得します。 次の OpenXmlElement がない場合は、null (Visual Basic では Nothing) を返します。 (継承元 OpenXmlElement)
PrependChild<T>(T)	現在の要素の子ノードのリストの先頭に、指定した要素を挿入します。 (継承元 OpenXmlCompositeElement)
PreviousSibling()	現在の OpenXmlElement 要素のすぐ前にある OpenXmlElement 要素を取得します。 前に OpenXmlElement 要素がない場合は、null (Visual Basic では Nothing) を返します。 (継承元 OpenXmlElement)
PreviousSibling<T>()	現在の OpenXmlElement の前に指定された型を持つ OpenXmlElement 要素を取得します。 前に OpenXmlElement 要素がない場合は null (Visual Basic では Nothing) を返します。 (継承元 OpenXmlElement)
Remove()	現在の要素を親から削除します。 (継承元 OpenXmlElement)
RemoveAllChildren()	現在の要素のすべての子要素を削除します。 (継承元 OpenXmlCompositeElement)
RemoveAllChildren<T>()	T 型の現在の要素の子要素をすべて削除します。 (継承元 OpenXmlElement)
RemoveAnnotations(Type)	指定した型の注釈を現在の OpenXmlElement 要素から削除します。 (継承元 OpenXmlElement)
RemoveAnnotations<T>()	指定した型の注釈を現在の OpenXmlElement 要素から削除します。 (継承元 OpenXmlElement)
RemoveAttribute(String, String)	現在の要素から 属性を削除します。 (継承元 OpenXmlElement)
RemoveChild<T>(T)	指定した子要素を削除します。 (継承元 OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	指定したプレフィックスの名前空間宣言を削除します。 プレフィックスがない場合は、何も削除しません。 (継承元 OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	現在の要素の子要素の 1 つを別の OpenXmlElement 要素に置き換えます。 (継承元 OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	指定した要素に属性を設定します。 属性が既知の属性の場合、属性の値が設定されます。 属性が拡張属性の場合は、拡張属性リストに 'openxmlAttribute' が追加されます。 (継承元 OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	要素に複数の属性を設定します。 属性が既知の属性の場合、属性の値が設定されます。 属性が拡張属性の場合は、拡張属性リストに 'openxmlAttribute' が追加されます。 (継承元 OpenXmlElement)
WriteTo(XmlWriter)	現在のノードを指定した XmlWriter に保存します。 (継承元 OpenXmlElement)

明示的なインターフェイスの実装

IEnumerable.GetEnumerator()	繋がり。 このクラスは、Office 2007 以降で使用できます。 オブジェクトを xml としてシリアル化されるときに、修飾名は x:connection です。 (継承元 OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	子コレクションを反復処理する列挙子を返します。 (継承元 OpenXmlElement)