XmlForm Classe

Definição

Namespace:

Microsoft.Office.InfoPath

Assembly:

Microsoft.Office.InfoPath.dll

Representa o documento XML subjacente de um formulário.

public ref class XmlForm abstract

public abstract class XmlForm

type XmlForm = class

Public MustInherit Class XmlForm

Herança

Object

XmlForm

Comentários

A XmlForm classe é um objeto-chave no modelo de objeto de código gerenciado do InfoPath que fornece propriedades, métodos e eventos que podem ser usados para interagir programaticamente e manipular os dados XML no documento XML subjacente de um formulário.

Embora XmlForm os objetos possam ser acessados da XmlFormCollection classe usando a XmlForms propriedade da classe, na maioria dos Application casos, ao trabalhar com a lógica de negócios do modelo de formulário, você acessará a XmlForm classe e seus membros usando as palavras-chave ( em C#) ou Eu (no Visual Basic) sem passar pela coleção.

Por exemplo, os exemplos de código a seguir de manipuladores de eventos para o Loading evento usam as palavras-chave this ou Me para acessar as MainDataSource propriedades e NamespaceManager da XmlForm classe. Essas propriedades são usadas para funcionar com uma instância do System.Xml. Campo de funcionários XPath.XPathNavigator (resolvendo prefixos de namespace usando a NamespaceManager propriedade) e, em seguida, defina o campo como nome de usuário do usuário atual.

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

Observação: não é necessário referenciar explicitamente as palavras-chave this ou Me para acessar os membros da XmlForm classe no código de formulário. Por exemplo, as linhas de código para acessar a MainDataSource propriedade nos exemplos anteriores do C# e do Visual Basic podem ser escritas da seguinte maneira:

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

No entanto, usar as palavras-chave this ou Me ao escrever código facilita a conclusão da instrução IntelliSense, que lista os membros da classe ao escrever código XmlForm lógico de negócios no módulo FormCode de um modelo de formulário.

Ao trabalhar com código gerenciado, os dados XML de origem de um formulário são acessados por meio da MainDataSource propriedade que retorna uma instância da DataSource classe que representa o main fonte de dados do formulário. O CreateNavigator() método da DataSource classe é então usado para criar uma instância do System.Xml. Classe XPath.XPathNavigator que está posicionada na raiz do documento XML subjacente do formulário. Os membros da classe XPathNavigator podem então ser usados para navegar, ler e gravar nos dados do formulário. Para obter mais informações sobre como usar a classe XPathNavigator no código de formulário do InfoPath, consulte Como trabalhar com System.Xml de Modelos de Formulário de Código Gerenciado.

A XmlForm classe também fornece propriedades adicionais que podem ser usadas para obter informações sobre o formulário e seu documento XML subjacente. Ele também fornece métodos que podem ser usados para executar várias ações com o formulário, como impressão, salvamento e envio. Eventos no nível do formulário, como carregar um formulário, alternar exibições ou uma operação de mesclagem, são implementados pela FormEvents classe. Além disso, os eventos gerados por alterações no documento XML subjacente em si são implementados pela XmlEvents classe.

O XmlForm objeto pode ser acessado das XmlFormCollection classes e Window no modelo de objeto InfoPath. A tabela a seguir lista esses locais em que o XmlForm objeto está disponível.

XmlFormCollection	Acessado do Application objeto usando a XmlForms propriedade. Fornece a propriedade e Microsoft.Office.InfoPath.XmlFormCollection.Open o Item[Int32] método para acessar os XmlForm objetos que ele contém.
Window	Fornece a XmlForm propriedade para acessar o XmlForm objeto associado à janela.

No modelo de objeto de código gerenciado compatível com o InfoPath 2003 (os tipos e membros do Microsoft.Office.Interop.InfoPath.SemiTrust namespace), que foi introduzido pela primeira vez no InfoPath 2003 Service Pack 1 em conjunto com o Kit de Ferramentas do Microsoft Office InfoPath 2003 para Visual Studio .NET, as seguintes classes forneceram uma propriedade XDocument para acessar o documento XML subjacente de um formulário durante os eventos: DataDOMEventObject, DocActionEventObject, DocEventObject, DocReturnEventObjecte VersionUpgradeEventObject classes.

No novo modelo de objeto de código gerenciado do InfoPath (os tipos e membros do Microsoft.Office.InfoPath namespace), você usa as palavras-chave isso (em C#) ou Eu (no Visual Basic) para acessar a XmlForm classe e seus membros de manipuladores de eventos e de outros códigos na lógica de negócios do modelo de formulário.

Construtores

XmlForm()

Representa o documento XML subjacente de um formulário.

Propriedades

CurrentView	Obtém um View objeto que representa a exibição atual do formulário.
DataConnections	Obtém um DataConnectionCollection objeto associado ao formulário.
DataSources	Obtém o DataSourceCollection objeto associado ao formulário.
Dirty	Obtém ou define um valor que indica se os dados em um formulário foram modificados desde a última salvação.
Environment	Obtém um Environment objeto que fornece informações sobre em qual ambiente de runtime (editor do InfoPath, navegador da Web ou navegador móvel) o formulário está em execução.
Errors	Obtém uma referência ao FormErrorCollection que está associado a um formulário.
Extension	Obtém um Object para acessar as funções e variáveis globais contidas no arquivo de código de formulário primário de um formulário usando System.Reflection.
FormState	Obtém uma referência a um recipiente de propriedades do tipo System.Collections.IDictionary que os formulários habilitados para navegador podem usar para manter informações de estado entre sessões no servidor.
Host	Obtém um System.Object que o código em execução em uma instância hospedada do InfoPath pode usar para acessar o modelo de objeto do aplicativo host.
Hosted	Obtém se o InfoPath está hospedado como um controle em outro aplicativo.
HostName	Obtém o nome do aplicativo que hospeda o InfoPath como um controle.
MainDataSource	Obtém um DataSource objeto que representa a main fonte de dados do formulário.
NamespaceManager	Obtém uma referência a um XmlNamespaceManager objeto que pode ser usado para resolve, adicionar ou remover namespaces usados no formulário.
NetworkState	Obtém um NetworkState objeto que fornece informações sobre o estado de conexão do computador cliente ou se uma conexão pode ser feita com o destino de rede especificado.
New	Obtém um valor que especifica se um formulário é novo.
Permission	Obtém uma referência a um Permission objeto associado ao formulário.
QueryDataConnection	Obtém uma referência ao DataConnection objeto que representa a conexão de dados associada ao formulário.
ReadOnly	Obtém um valor que indica se um modelo de formulário é somente leitura ou está bloqueado.
Recovered	Obtém um valor que indica se um formulário foi salvo pela última vez por uma operação de salvamento de AutoRecuperação.
ServerInfo	Obtém um ServerInfo objeto que fornece informações sobre o servidor do SharePoint onde o formulário está localizado.
Signed	Obtém um valor que indica se um formulário foi assinado digitalmente usando assinaturas digitais.
SignedDataBlocks	Obtém uma referência à SignedDataBlockCollection coleção associada a um formulário.
TaskPanes	Obtém uma referência ao TaskPaneCollection que está associado a um modelo de formulário.
Template	Obtém uma referência ao FormTemplate objeto que representa o manifesto (.xsf) do modelo de formulário associado ao formulário.
Uri	Obtém o URI (Uniform Resource Identifier) de um formulário.
User	Obtém um User objeto que fornece informações sobre o usuário atual do formulário.
UserRole	Obtém ou define o usuário atual do nome da função do formulário.
ViewInfos	Obtém uma referência ao ViewInfoCollection objeto associado ao modelo de formulário.
XmlLang	Obtém ou define o valor do atributo xml:lang no documento XML subjacente do formulário.

Métodos

Close()	Fecha o formulário.
GetWorkflowTasks()	Obtém uma referência a uma coleção Microsoft.Office.Core.WorkflowTasks para o formulário atual.
GetWorkflowTemplates()	Obtém uma referência a uma coleção Microsoft.Office.Core.WorkflowTemplates para o formulário atual.
MergeForm(String)	Mescla o formulário atual com o formulário especificado por caminho ou URL.
MergeForm(XPathNavigator)	Mescla o formulário atual com o formulário de destino especificado no nó retornado pelo XPathNavigator passado para o método.
NotifyHost(String)	Fornece um valor personalizado para o aplicativo de hospedagem ou a página ASPX.
Print()	Imprime o conteúdo do formulário à medida que ele é renderizado na visualização ativa do formulário.
Print(Boolean)	Imprime o conteúdo do formulário à medida que é renderizado o modo de exibição ativo do formulário exibindo a caixa de diálogo Imprimir.
Save()	Salva o formulário na URL à qual ele está associado no momento.
SaveAs(String)	Salva o formulário na URL especificada.
SetSaveAsDialogFilename(String)	Define o nome do arquivo padrão para a caixa de diálogo Salvar como.
SetSaveAsDialogLocation(String)	Define o caminho padrão para salvar o formulário usando a caixa de diálogo Salvar como.
Submit()	Envia o formulário usando a operação de envio definida no modelo de formulário.