XDocument Интерфейс

Определение

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

Microsoft.Office.Interop.InfoPath.SemiTrust

Сборка:

Microsoft.Office.Interop.InfoPath.SemiTrust.dll

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

public interface class XDocument : Microsoft::Office::Interop::InfoPath::SemiTrust::_XDocument2

[System.Runtime.InteropServices.Guid("096cd6a8-0786-11d1-95fa-0080c78ee3bb")]
public interface XDocument : Microsoft.Office.Interop.InfoPath.SemiTrust._XDocument2

type XDocument = interface
    interface _XDocument2
    interface _XDocument

Public Interface XDocument
Implements _XDocument2

Атрибуты

GuidAttribute

Реализации

_XDocument2

Примеры

Исходные XML-данные формы принимают форму модели DOM, доступ к которой осуществляется через DOM свойство объекта XDocument . Объект XDocument также содержит ряд свойств, которые можно использовать для получения сведений о форме и базовом документе XML. Например, следующий код проверяет, были ли изменены данные в форме с помощью IsDirty свойства :

if (thisXDocument.IsDirty)
{
   thisXDocument.UI.Alert("Form has been changed.");
}
else
{
   thisXDocument.UI.Alert("Form has not been changed.");
}

Кроме сведений о форме и базовом документе XML, объект XDocument содержит ряд методов, которые можно использовать для формы (например, операции печати, сохранения и отправки). Он также содержит ряд событий, которые можно использовать для реагирования на различные действия на уровне формы, такие как операции загрузки формы, переключения представлений и слияния.

См. другой пример, иллюстрирующий работу с объектом XDocument, в разделе

Практическое руководство. Доступ к данным приложения (объектная модель InfoPath 2003).

Комментарии

Этот тип является оболочкой для компонентного класса, необходимого управляемому коду для взаимодействия с COM. Используйте этот тип для доступа к элементам интерфейса COM, реализованного этим компонентным классом. Сведения об интерфейсе COM, включая ссылку на описания его членов, см. в разделе_XDocument2 .

Использование элементов интерфейса _XDocument2 обеспечивает совместимость с InfoPath 2003. Чтобы использовать новые члены, добавленные в объектную модель XDocument в Microsoft InfoPath 2010, русская версия, Permission например свойство, необходимо привести объект XDocument к типу _XDocument3 . Дополнительные сведения см. в разделе How to: Use Object Model Members That Are Not Compatible with InfoPath 2003.

Объект XDocument — это основной объект объектной модели InfoPath, содержащий свойства, методы и события, которые можно использовать для программного взаимодействия с XML-данными формы и манипуляции ими.

Хотя доступ к объекту XDocument можно получить с помощью XDocumentsCollection коллекции, в большинстве случаев доступ к нему будет осуществляться из переменной thisXDocument, созданной в методе _Startup проекта с управляемым кодом, не проходя через коллекцию.

Исходные XML-данные формы принимают форму модели DOM, доступ к которой осуществляется через DOM свойство . Объект XDocument также содержит ряд свойств, которые можно использовать для получения сведений о форме и базовом документе XML. Он также содержит ряд методов, которые можно использовать для формы (например, печать, сохранение и отправка). Кроме того, объект XDocument содержит ряд событий, которые можно использовать для реагирования на различные действия на уровне формы, такие как операция загрузки формы, переключения представлений или объединения.

Получение доступа к объекту XDocument

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

XDocumentsCollection	Доступ из Application. Предоставляет Item[Object] доступ к содержащимся в нем объектам XDocument .
DataDOMEventObject	Предоставляет XDocument доступ к исходным XML-данным во время изменения XML-модели DOM.
DocActionEventObject	Предоставляет XDocument доступ к исходным XML-данным при нажатии кнопки в области формы.
DocEventObject	Предоставляет XDocument доступ к исходным XML-данным во время переключения представления или операции слияния форм.
DocReturnEventObject	Предоставляет XDocument доступ к исходному XML-коду во время загрузки или отправки формы.
VersionUpgradeEventObject	Предоставляет XDocument доступ к исходному XML-коду во время операции обновления версии.
WindowObject	Предоставляет XDocument доступ к объекту XDocument , связанному с окном.

Свойства

DataAdapters	Возвращает ссылку на коллекцию DataAdaptersCollection , связанную с формой. (Унаследовано от _XDocument2)
DataObjects	Возвращает ссылку на коллекцию DataObjectsCollection , связанную с формой. (Унаследовано от _XDocument2)
DOM	Возвращает ссылку на базовый XML-документ формы в форме модели объектов XML-документов (DOM). (Унаследовано от _XDocument2)
Errors	Возвращает ссылку ErrorsCollection на объект , связанный с формой. (Унаследовано от _XDocument2)
Extension	Получает ссылку на глобальный объект скриптов, который отображает функции и глобальные переменные, содержащиеся в файле основного кода формы. (Унаследовано от _XDocument2)
IsDirty	Получает значение, указывающее на то, были ли изменены данные формы с момента последнего сохранения. (Унаследовано от _XDocument2)
IsDOMReadOnly	Получает значение, указывающее на то, были ли данные в базовом документе XML формы переведены в состояние "только для чтения". (Унаследовано от _XDocument2)
IsNew	Получает значение, указывающее на то, была ли сохранена только что созданная форма. (Унаследовано от _XDocument2)
IsReadOnly	Получает значение, указывающее, находится ли форма в режиме "только для чтения". (Унаследовано от _XDocument2)
IsRecovered	Получает значение, указывающее, была ли при предыдущем сохранении формы использована операция сохранения AutoRecover. (Унаследовано от _XDocument2)
IsSigned	Получает значение, указывающее, была ли форма подписана с использованием цифровой подписи. (Унаследовано от _XDocument2)
Language	Получает или задает код языка формы по умолчанию. (Унаследовано от _XDocument2)
QueryAdapter	Получает ссылку на объект адаптера данных, связанный с формой. (Унаследовано от _XDocument2)
Role	Возвращает или задает текущую роль пользователя. (Унаследовано от _XDocument2)
SignedDataBlocks	Возвращает ссылку на коллекцию SignedDataBlocksCollection , связанную XDocument с объектом . (Унаследовано от _XDocument2)
Solution	Возвращает ссылку на SolutionObject объект, связанный с формой. (Унаследовано от _XDocument2)
UI	Возвращает ссылку UIObject на объект . (Унаследовано от _XDocument2)
URI	Получает универсальный код ресурса (URI) формы. (Унаследовано от _XDocument2)
Util	Возвращает ссылку на UtilObject объект . (Унаследовано от _XDocument2)
View	Возвращает ссылку на объект , связанный ViewObject с формой. (Унаследовано от _XDocument2)
ViewInfos	Возвращает ссылку на коллекцию, ViewInfosCollection связанную с формой. (Унаследовано от _XDocument2)

Методы

CreateDOM()	Создает новый экземпляр модели объектов XML-документов (DOM) в памяти. (Унаследовано от _XDocument2)
GetDataVariable(Int32)	Возвращает значение указанной переменной, которая является предопределенной переменной, сохраненной в качестве атрибута инструкции обработки в базовом XML-документе формы. (Унаследовано от _XDocument2)
GetDOM(String)	Возвращает ссылку на объектную модель XML-документа (DOM) указанного DataSourceObject объекта, связанного XDocument с объектом . (Унаследовано от _XDocument2)
GetNamedNodeProperty(Object, String, String)	Возвращает значение именованного свойства для указанного узла XML, который должен быть узлом nonattribute в основном источнике данных. (Унаследовано от _XDocument2)
ImportDOM(IXMLDOMDocument)	Импортирует заданные XML-данные в текущую форму. (Унаследовано от _XDocument2)
ImportFile(String)	Импортирует заданную форму в текущую форму. (Унаследовано от _XDocument2)
PrintOut()	Печать содержимого формы, как представлено в окне, соответствующем активному представлению формы. (Унаследовано от _XDocument2)
Query()	Получает данные из связанного объекта адаптера данных формы и сохраняет эти данные в модели объектов базового документа XML формы. (Унаследовано от _XDocument2)
Save()	Сохраняет форму по указанному URL-адресу, с которым она в настоящий момент связана. (Унаследовано от _XDocument2)
SaveAs(String)	Сохраняет форму по указанному URL-адресу. (Унаследовано от _XDocument2)
SetDataVariable(Int32, String)	Задает значение предопределенной переменной, хранящейся как атрибут команды обработки и базовом документе XML формы. (Унаследовано от _XDocument2)
SetDirty(Boolean)	IsDirty Задает свойство для XDocument объекта , которое указывает, были ли изменены данные в форме с момента последнего сохранения. (Унаследовано от _XDocument2)
SetNamedNodeProperty(IXMLDOMNode, String, String)	Задает значение именованного свойства для указанного узла XML, который должен быть узлом nonattribute в основном источнике данных. (Унаследовано от _XDocument2)
Submit()	Выполняет предопределенную операцию отправки в форме. (Унаследовано от _XDocument2)