XmlForm Класс

Определение

Пространство имен:

Microsoft.Office.InfoPath

Сборка:

Microsoft.Office.InfoPath.dll

Представляет базовый документ XML формы.

public ref class XmlForm abstract

public abstract class XmlForm

type XmlForm = class

Public MustInherit Class XmlForm

Наследование

Object

XmlForm

Комментарии

Класс XmlForm является ключевым объектом в объектной модели управляемого кода InfoPath, который предоставляет свойства, методы и события, которые можно использовать для программного взаимодействия с XML-данными и управления ими в базовом XML-документе формы.

Хотя XmlForm доступ к объектам из XmlFormCollection класса можно получить с помощью XmlForms свойства Application класса, в большинстве случаев при работе с бизнес-логикой шаблона формы вы будете обращаться к классу XmlForm и его членам с помощью ключевых слов this (в C#) или Me (в Visual Basic), не проходя через коллекцию.

Например, в следующих примерах кода обработчиков событий для Loading события используются ключевые слова this или Me для доступа MainDataSource к свойствам XmlForm и NamespaceManager класса . Эти свойства используются для работы с экземпляром 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 формы. Например, строки кода для доступа к свойству MainDataSource в предыдущих примерах C# и Visual Basic можно написать следующим образом:

XPathNavigator myNav = MainDataSource.CreateNavigator()
Dim myNav As XPathNavigator = MainDataSource.CreateNavigator()

Однако использование ключевых слов this или Me при написании кода упрощает завершение инструкции IntelliSense, в которой перечислены члены класса при написании XmlForm кода бизнес-логики в модуле FormCode шаблона формы.

При работе с управляемым кодом доступ к исходным XML-данным формы осуществляется через MainDataSource свойство , которое возвращает экземпляр DataSource класса , представляющего main источник данных формы. Затем CreateNavigator() метод DataSource класса используется для создания экземпляра System.Xml. Класс XPath.XPathNavigator , расположенный в корне базового XML-документа формы. Члены класса XPathNavigator затем могут использоваться для навигации по данным формы, их чтения и записи. Дополнительные сведения об использовании класса XPathNavigator в коде формы InfoPath см. в разделе Практическое руководство. Работа с System.Xml из шаблонов форм с управляемым кодом.

Класс XmlForm также предоставляет дополнительные свойства, которые можно использовать для получения сведений о форме и ее базовом XML-документе. Также он обеспечивает методы, которые можно использовать для выполнения различных действий с формой, таких как печать, сохранение и отправка. События уровня формы, такие как загрузка формы, переключение представлений или операция слияния, реализуются классом FormEvents . Кроме того, события, вызванные изменениями в самом базовом XML-документе, реализуются классом XmlEvents .

Доступ XmlForm к объекту XmlFormCollection можно получить из классов и Window в объектной модели InfoPath. В следующей таблице перечислены эти расположения, в которых XmlForm доступен объект .

XmlFormCollection	Доступ из Application объекта используется XmlForms с помощью свойства . Item[Int32] Предоставляет свойство и Microsoft.Office.InfoPath.XmlFormCollection.Open метод для доступа к содержащимся в XmlForm нем объектам.
Window	XmlForm Предоставляет свойство для доступа к объекту, XmlForm связанному с окном.

В совместимой с InfoPath 2003 объектной модели управляемого Microsoft.Office.Interop.InfoPath.SemiTrust кода (типы и члены пространства имен), которая была впервые представлена в InfoPath 2003 с пакетом обновления 1 (SP1) вместе с набором средств Microsoft Office InfoPath 2003 для Visual Studio .NET, следующие классы предоставили свойство XDocument для доступа к базовому XML-документу формы во время событий: DataDOMEventObjectКлассы , DocActionEventObject, DocEventObject, DocReturnEventObjectи VersionUpgradeEventObject .

В новой объектной модели управляемого кода InfoPath (типы и члены пространства имен) вы используете ключевые слова this (в C#) или Me (в Visual Basic) для доступа к классу XmlForm и его членам из обработчиков событий и из другого Microsoft.Office.InfoPath кода в бизнес-логике шаблона формы.

Конструкторы

XmlForm()

Представляет базовый документ XML формы.

Свойства

CurrentView	View Возвращает объект , представляющий текущее представление формы.
DataConnections	Возвращает объект, связанный DataConnectionCollection с формой.
DataSources	Возвращает объект, DataSourceCollection связанный с формой.
Dirty	Возвращает или задает значение, которое указывает, были ли изменены данные в форме со времени последнего сохранения.
Environment	Возвращает объект, предоставляющий Environment сведения о среде выполнения (редактор InfoPath, веб-браузер или мобильный браузер), в которой выполняется форма.
Errors	Возвращает ссылку FormErrorCollection на объект , связанный с формой.
Extension	Возвращает для Object доступа к функциям и глобальным переменным, содержащимся в основном файле кода формы, с помощью System.Reflection.
FormState	Возвращает ссылку на контейнер свойств System.Collections.IDictionary типа, которые могут использовать формы с поддержкой браузера для обработки сведений о состоянии сеансов на сервере.
Host	Возвращает System.Object, который код, запущенный в размещенном экземпляре InfoPath, может использовать для доступа к объектной модели внешнего приложения.
Hosted	Определяет, размещен ли InfoPath в качестве элемента управления в другом приложении.
HostName	Возвращение имени приложения,где размещается InfoPath в качестве элемента управления.
MainDataSource	DataSource Возвращает объект , представляющий main источник данных формы.
NamespaceManager	Возвращает ссылку XmlNamespaceManager на объект, который можно использовать для разрешения, добавления или удаления пространств имен, используемых в форме.
NetworkState	NetworkState Возвращает объект , предоставляющий сведения о состоянии подключения клиентского компьютера или о том, можно ли установить подключение к указанному сетевому назначению.
New	Возвращает значение, которое указывает, является ли форма новой.
Permission	Возвращает ссылку на объект, связанный Permission с формой.
QueryDataConnection	Возвращает ссылку на DataConnection объект , представляющий соединение с данными, связанное с формой.
ReadOnly	Возвращает значение, которое указывает, имеет ли шаблон доступ только для чтение или заблокирован.
Recovered	Получает значение, указывающее, была ли при предыдущем сохранении формы использована операция сохранения AutoRecover.
ServerInfo	Возвращает объект, предоставляющий ServerInfo сведения о сервере SharePoint, где находится форма.
Signed	Получает значение, указывающее, была ли форма подписана с использованием цифровой подписи.
SignedDataBlocks	Возвращает ссылку на коллекцию SignedDataBlockCollection , связанную с формой.
TaskPanes	Возвращает ссылку на TaskPaneCollection объект , связанный с шаблоном формы.
Template	Возвращает ссылку на FormTemplate объект , представляющий манифест (XSF) шаблона формы, связанного с формой.
Uri	Получает универсальный код ресурса (URI) формы.
User	User Возвращает объект , предоставляющий сведения о текущем пользователе формы.
UserRole	Возвращает или задает текущего пользователя имени роли формы.
ViewInfos	Возвращает ссылку на объект, связанный ViewInfoCollection с шаблоном формы.
XmlLang	Возвращает или задает значение атрибута xml:lang в базовом XML-документе формы.

Методы

Close()	Закрывает форму.
GetWorkflowTasks()	Возвращает ссылку на коллекцию Microsoft.Office.Core.WorkflowTasks для текущей формы.
GetWorkflowTemplates()	Возвращает ссылку на коллекцию Microsoft.Office.Core.WorkflowTemplates для текущей формы.
MergeForm(String)	Объединяет текущую форму с формой, указанной с помощью пути или URL-адреса.
MergeForm(XPathNavigator)	Объединяет текущую форму с целевой формой, указанной в узле, возвращенном методом XPathNavigator , переданным методу .
NotifyHost(String)	Предоставляет пользовательское значение для внешнего приложения или ASPX-страницы.
Print()	Печатает содержимое формы, отображаемое в активном представлении формы.
Print(Boolean)	Печатает содержимое формы, отображаемое в активном представлении формы, с использованием диалогового окна Печать.
Save()	Сохраняет форму по указанному URL-адресу, с которым она в настоящий момент связана.
SaveAs(String)	Сохраняет форму по указанному URL-адресу.
SetSaveAsDialogFilename(String)	Устанавливает имя файла по умолчанию для диалогового окна SaveAs.
SetSaveAsDialogLocation(String)	Устанавливает путь по умолчанию для сохранения формы с помощью диалогового окна SaveAs.
Submit()	Отправляет форму с помощью операции отправки, определенной в шаблоне формы.