XmlForm クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
フォームの基になる XML ドキュメントを表します。
public ref class XmlForm abstract
public abstract class XmlForm
type XmlForm = class
Public MustInherit Class XmlForm
- 継承
-
XmlForm
注釈
XmlFormクラスは InfoPath マネージ コード オブジェクト モデルのキー オブジェクトであり、フォームの基になる XML ドキュメント内の XML データをプログラムで操作および操作するために使用できるプロパティ、メソッド、イベントを提供します。
XmlFormクラスの Application プロパティをXmlForms使用してクラスからXmlFormCollectionオブジェクトにアクセスできますが、ほとんどの場合、フォーム テンプレートのビジネス ロジックを使用する場合は、コレクションを通過せずに、この (C#では) または Me (Visual Basic) キーワードを使用してクラスとそのメンバーにアクセスXmlFormします。
たとえば、イベントのイベント ハンドラーLoadingの次のコード例では、this キーワードまたは Me キーワードを使用して、 クラスの プロパティと NamespaceManager プロパティにXmlFormアクセスMainDataSourceします。 これらのプロパティは、System.Xml のインスタンスを操作するために使用 されます。XPath.XPathNavigatorの従業員 フィールド (プロパティを使用 NamespaceManager して名前空間プレフィックスを解決) し、フィールドを現在のユーザーのユーザー名に設定します。
public void FormEvents_Loading(object sender, LoadingEventArgs e)
{
// Create XPathNavigator positioned at the root of the main data
// source.
XPathNavigator myNav = this.MainDataSource.CreateNavigator()
// Select employee field and set value to username.
myNav.SelectSingleNode("//my:employee",this.NamespaceManager).
SetValue(System.Environment.UserName);
}
Public Sub FormEvents_Loading(ByVal sender As Object, ByVal e As LoadingEventArgs)
' Create XPathNavigator positioned at the root of the main data
' source.
Dim myNav As XPathNavigator = Me.MainDataSource.CreateNavigator()
' Select employee field and set value to username.
myNav.SelectSingleNode("//my:employee", Me.NamespaceManager). _
SetValue(System.Environment.UserName)
End Sub
注: フォーム コード内のクラスのメンバーにアクセスするために 、this キーワードまたは Me キーワードを明示的に参照する XmlForm 必要はありません。 たとえば、前の C# と Visual Basic の例のプロパティにアクセス MainDataSource するためのコード行は、次のように記述できます。
XPathNavigator myNav = MainDataSource.CreateNavigator()
Dim myNav As XPathNavigator = MainDataSource.CreateNavigator()
ただし、コードを記述するときに this キーワードまたは Me キーワードを使用すると、IntelliSense ステートメントの完了が容易になります。これは、フォーム テンプレートの FormCode モジュールでビジネス ロジック コードを XmlForm 記述するときにクラスのメンバーを一覧表示します。
マネージド コードを操作する場合、フォームのソース XML データにアクセスするには、 プロパティをMainDataSource使用して、フォームのメイン データ ソースを表す クラスのDataSourceインスタンスを返します。 CreateNavigator()次に、 クラスの DataSource メソッドを使用して、System.Xml のインスタンスを作成します。フォームの基になる XML ドキュメントのルートに配置される XPath.XPathNavigator クラス。 その後、 XPathNavigator クラスのメンバーを使用して、フォーム データの移動、読み取り、書き込みを行うことができます。 InfoPath フォーム コードで XPathNavigator クラスを使用する方法の詳細については、「方法: マネージ コード フォーム テンプレートから System.Xml を操作する」を参照してください。
クラスには XmlForm 、フォームとその基になる XML ドキュメントに関する情報を取得するために使用できる追加のプロパティも用意されています。 また、フォームに対して印刷、保存、送信などのさまざまなアクションを実行するために使用できるメソッドも提供されています。 フォームの読み込み、ビューの切り替え、マージ操作などのフォーム レベルのイベントは、 クラスによって FormEvents 実装されます。 さらに、基になる XML ドキュメント自体に対する変更によって発生するイベントは、 クラスによって XmlEvents 実装されます。
オブジェクトには XmlForm 、InfoPath オブジェクト モデルの XmlFormCollection および Window クラスからアクセスできます。 次の表に、オブジェクトが使用可能な場所を XmlForm 示します。
XmlFormCollection | プロパティを Application 使用 XmlForms してオブジェクトからアクセスします。 含まれているオブジェクトにItem[Int32]アクセスするためのXmlFormプロパティとMicrosoft.Office.InfoPath.XmlFormCollection.Openメソッドを提供します。 |
Window | ウィンドウに XmlForm 関連付けられているオブジェクトに XmlForm アクセスするためのプロパティを提供します。 |
InfoPath 2003 互換マネージド コード オブジェクト モデル (名前空間の Microsoft.Office.Interop.InfoPath.SemiTrust 型とメンバー) では、InfoPath 2003 Service Pack 1 で Microsoft Office InfoPath 2003 Toolkit for Visual Studio .NET と組み合わせて初めて導入されました。次のクラスでは、イベント中にフォームの基になる XML ドキュメントにアクセスするための XDocument プロパティを提供しました。 DataDOMEventObject、 DocActionEventObject、 DocEventObject、 DocReturnEventObjectおよび VersionUpgradeEventObject クラス。
新しい InfoPath マネージ コード オブジェクト モデル (名前空間の Microsoft.Office.InfoPath 型とメンバー) では、 この (C#では) キーワードまたは Me (Visual Basic の場合) キーワードを使用して、イベント ハンドラーから、およびフォーム テンプレートのビジネス ロジック内の他のコードからクラスとそのメンバーにアクセス XmlForm します。
コンストラクター
XmlForm() |
フォームの基になる XML ドキュメントを表します。 |
プロパティ
CurrentView |
フォームの View 現在のビューを表す オブジェクトを取得します。 |
DataConnections |
フォームに DataConnectionCollection 関連付けられているオブジェクトを取得します。 |
DataSources |
フォームに DataSourceCollection 関連付けられているオブジェクトを取得します。 |
Dirty |
フォームのデータが最後に保存されてから変更されたかどうかを示す値を取得または設定します。 |
Environment |
フォームが Environment 実行されているランタイム環境 (InfoPath エディター、Web ブラウザー、またはモバイル ブラウザー) に関する情報を提供するオブジェクトを取得します。 |
Errors |
フォームに関連付けられている への FormErrorCollection 参照を取得します。 |
Extension |
System.Reflection をObject使用して、フォームのプライマリ フォーム コード ファイルに含まれる関数とグローバル変数にアクセスするための を取得します。 |
FormState |
サーバー上の複数のセッションにわたって状態情報を維持するためにブラウザー対応のフォームで使用できる、System.Collections.IDictionary 型のプロパティ バッグへの参照を取得します。 |
Host |
ホストされた InfoPath のインスタンスで実行しているコードでホスト アプリケーションのオブジェクト モデルにアクセスするために使用できる、System.Object を取得します。 |
Hosted |
InfoPath が別のアプリケーションでコントロールとしてホストされているかどうかを取得します。 |
HostName |
InfoPath をコントロールとしてホストしているアプリケーションの名前を取得します。 |
MainDataSource |
フォームのDataSourceメイン データ ソースを表す オブジェクトを取得します。 |
NamespaceManager |
フォームで使用される名前空間の XmlNamespaceManager 解決、追加、または削除に使用できるオブジェクトへの参照を取得します。 |
NetworkState |
クライアント コンピューターの NetworkState 接続状態に関する情報を提供するオブジェクトを取得します。また、指定したネットワーク宛先に接続できるかどうかを示します。 |
New |
フォームが新規かどうかを指定する値を取得します。 |
Permission |
フォームに関連付けられているオブジェクトへの Permission 参照を取得します。 |
QueryDataConnection |
フォームに関連付けられているデータ接続を表す オブジェクトへの DataConnection 参照を取得します。 |
ReadOnly |
フォーム テンプレートが読み取り専用またはロックされているかどうかを示す値を取得します。 |
Recovered |
フォームが最後に保存されたのが自動保存操作によるものかどうかを示す値を取得します。 |
ServerInfo |
フォームが ServerInfo 配置されている SharePoint サーバーに関する情報を提供するオブジェクトを取得します。 |
Signed |
フォームがデジタル署名を使用してデジタル署名されているかどうかを示す値を取得します。 |
SignedDataBlocks |
フォームに関連付けられているコレクションへの SignedDataBlockCollection 参照を取得します。 |
TaskPanes |
フォーム テンプレートに関連付けられている への TaskPaneCollection 参照を取得します。 |
Template |
フォームに関連付けられているフォーム テンプレートの FormTemplate マニフェスト (.xsf) を表す オブジェクトへの参照を取得します。 |
Uri |
フォームの Uniform Resource Identifier (URI) を取得します。 |
User |
フォームの現在の User ユーザーに関する情報を提供する オブジェクトを取得します。 |
UserRole |
フォームのロール名の現在のユーザーを取得または設定します。 |
ViewInfos |
フォーム テンプレートに関連付けられているオブジェクトへの ViewInfoCollection 参照を取得します。 |
XmlLang |
フォームの基になる XML ドキュメント内の xml:lang 属性の値を取得または設定します。 |
メソッド
Close() |
フォームを閉じます。 |
GetWorkflowTasks() |
現在のフォームの Microsoft.Office.Core.WorkflowTasks コレクションへの参照を取得します。 |
GetWorkflowTemplates() |
現在のフォームの Microsoft.Office.Core.WorkflowTemplates コレクションへの参照を取得します。 |
MergeForm(String) |
現在のフォームを、パスまたは URL によって指定されたフォームとマージします。 |
MergeForm(XPathNavigator) |
メソッドに渡された によって返されるノードで指定されたターゲット フォームと現在の XPathNavigator フォームをマージします。 |
NotifyHost(String) |
ホストしているアプリケーションまたは ASPX ページにカスタム値を提供します。 |
Print() |
フォームのアクティブ ビューに表示されているフォームの内容を印刷します。 |
Print(Boolean) |
[印刷] ダイアログ ボックスを表示することによって、フォームのアクティブ ビューに表示されているフォームの内容を印刷します。 |
Save() |
現在関連付けられている Uniform Resource Locator (URL) にフォームを保存します。 |
SaveAs(String) |
指定した Uniform Resource Locator (URL) にフォームを保存します。 |
SetSaveAsDialogFilename(String) |
[ 名前を付けて保存] ダイアログ ボックスを使用してフォームを保存するときの既定のファイル名を設定します。 |
SetSaveAsDialogLocation(String) |
[ 名前を付けて保存] ダイアログ ボックスを使用してフォームを保存するときの既定のパスを設定します。 |
Submit() |
フォーム テンプレートに定義された送信処理を使用してフォームを送信します。 |