Personalizar um modelo de formulário com um script

Se estiver familiarizado com a escrita de scripts, pode adicionar um script ao seu modelo de formulário do Microsoft Office InfoPath com o Microsoft JScript ou o idioma de scripting do Microsoft Visual Basic Scripting Edition (VBScript). Adicionar script permite-lhe personalizar o seu modelo de formulário para além do que está disponível com regras, fórmulas, validação de dados ou formatação condicional. Por exemplo, pode adicionar um script que cria e envia uma mensagem de e-mail quando um utilizador muda a vista num formulário com base no seu modelo de formulário. Pode configurar um modelo de formulário para criar e enviar uma mensagem de e-mail apenas com um script.

Neste artigo

• Descrição Geral
• Considerações de compatibilidade
• Definir a linguagem de scripts para um modelo de formulário
• Apresentar uma mensagem sempre que ocorrer um evento
• Adicionar um script que é executado quando um utilizador guarda os dados do formulário
• Adicionar um script que é executado quando um utilizador submete os dados do formulário
• Adicionar um script que é executado quando um utilizador clica num botão
• Adicionar um script que é executado quando os formulários existentes são intercalados
• Adicionar um script para atualizar os formulários existentes
• Adicionar um script para outros eventos

Descrição Geral

Pode personalizar o modelo de formulário do InfoPath através de regras, fórmulas, validação de dados e formatação condicional. Embora estas funcionalidades sejam muito flexíveis e consigam lidar com uma grande variedade de tarefas, algumas tarefas estão para além das capacidades destas funcionalidades. Por exemplo, não pode utilizar regras para enviar uma mensagem de e-mail quando um utilizador introduz um valor numa caixa de texto num formulário. Se precisar de personalizar o seu modelo de formulário de uma forma que ultrapasse as capacidades destas funcionalidades e estiver familiarizado com a escrita de scripts com a linguagem de script JScript ou VBScript, pode adicionar um script que é executado quando um utilizador abre um novo formulário ou modifica um formulário existente baseado no seu modelo de formulário.

Quando adiciona um script a um modelo de formulário, o InfoPath inicia o Microsoft Script Editor (MSE), que lhe permite adicionar, editar e depurar scripts num modelo de formulário e coloca o cursor no evento escolhido. O InfoPath adiciona automaticamente um processador de eventos ao script. Um processador de eventos é o código de função num modelo de formulário do InfoPath que responde a uma ação do utilizador ou a uma alteração aos dados XML num formulário. Por exemplo, se quiser que os seus utilizadores guardem os respetivos formulários em várias localizações de rede, pode adicionar um script ao processador de eventos OnSaveRequest . Quando adiciona um script para ser executado quando o utilizador guarda um formulário com base no seu modelo de formulário, o InfoPath inicia o editor de scripts e adiciona um dos seguintes códigos ao script.

JScript

//=======
// The following function handler is created by Microsoft Office InfoPath.
// Do not modify the name of the function, or the name and number of arguments.
//=======
function XDocument::OnSaveRequest(eventObj)
{
   // Write the code to be run before saving here.
   eventObj.IsCancelled = eventObj.PerformSaveOperation();
   // Write the code to be run after saving here.
   eventObj.ReturnStatus = true;
}

VBScript

'=======
' The following function handler is created by Microsoft Office InfoPath.
' Do not modify the name of the function, or the name and number of arguments.
'=======
Sub XDocument_OnSaveRequest(eventObj)
' Write the code to be run before saving here.
eventObj.IsCancelled = eventObj.PerformSaveOperation
' Write the code to be run after saving here.
eventObj.ReturnStatus = True
End Sub

Em seguida, pode adicionar código nos locais adequados no processador de eventos que guarda o formulário na localização de rede diferente. Quando um utilizador guarda um formulário com base neste modelo de formulário, o InfoPath executa o código no processador de eventos OnSaveRequest .

O InfoPath adiciona automaticamente processadores de eventos para todos, exceto um dos seguintes eventos.

Início da Página

Considerações de compatibilidade

Não é possível adicionar scripts a um modelo de formulário compatível com o browser. Só pode adicionar script a um modelo de formulário cujos formulários serão preenchidos no InfoPath. Só pode personalizar um modelo de formulário compatível com o browser com código gerido.

Início da Página

Definir a linguagem de scripts para um modelo de formulário

Para personalizar um modelo de formulário com script, pode utilizar o Microsoft JScript ou o Microsoft Visual Basic Scripting Edition (VBScript). Por predefinição, o InfoPath está configurado para adicionar script com jScript. Se o modelo de formulário não contiver nenhum script ou código gerido e preferir utilizar o VBScript como linguagem de script, pode alterar a linguagem de scripts do modelo de formulário para VBScript. Não pode utilizar ambos os idiomas de scripting no mesmo modelo de formulário.

Se o modelo de formulário já tiver scripts num idioma e quiser utilizar o outro idioma, terá de guardar o script existente para poder converter o script para outro idioma, remover o script do modelo de formulário através da caixa de diálogo Opções de Formulário e, em seguida, adicionar o script convertido novamente ao modelo de formulário. O InfoPath não consegue converter scripts numa nova linguagem de scripting. Alterar o idioma do script na caixa de diálogo Opções de Formulário afeta apenas este modelo de formulário. Outros modelos de formulário terão jScript como a linguagem de scripting predefinida.

1. No menu Ferramentas , clique em Opções de Formulário.

2. Na lista Categoria , na caixa de diálogo Opções de Formulário , clique em Programação.

3. Na lista Linguagem de código do modelo de formulário, em Linguagem de programação, clique em VBScript.

   Nota

   • Depois de definir a linguagem de scripting e criar um ou mais processadores de eventos para um modelo de formulário, não pode alterar a linguagem de scripting para o modelo de formulário.
   • Se tiver instalado o Microsoft Visual Studio 2005 Tools for Applications, o idioma predefinido é Microsoft Visual Basic .NET. Ainda pode utilizar este procedimento para alterar a linguagem de scripting para VBScript.

Início da Página

Apresentar uma mensagem sempre que ocorrer um evento

Se quiser saber que processadores de eventos são executados em resposta a uma ação ou outro evento, pode adicionar código temporário para apresentar uma caixa de mensagem sempre que o processador de eventos for executado. Deve utilizar este código apenas para determinar quando um processador de eventos é executado. Depois de adicionar este código, pode utilizar a pré-visualização para ver um formulário com base neste modelo de formulário ou para publicar o modelo de formulário e, em seguida, criar um novo modelo de formulário. Alguns processadores de eventos só são executados se criar um formulário depois de publicar o modelo de formulário. Em seguida, pode efetuar uma ação que pensa que pode executar o processador de eventos. Quando o processador de eventos for executado, verá uma caixa de mensagem.

Depois de determinar que ações ou eventos executam o processador de eventos, remova o código e, em seguida, retome a estruturação do modelo de formulário. Se não remover este código e, em seguida, publicar o modelo de formulário, os seus utilizadores verão esta caixa de mensagem quando o processador de eventos for executado.

1. Adicione o processador de eventos.

2. Para adicionar código no JScript, escreva XDocument.UI.Alert("O evento do nome do evento acabou de ser executado"); Substitua pelo nome do processador de eventos. Por exemplo, se adicionar este código ao processador de eventos OnValidate , escreveria XDocument.UI.Alert("O processador de eventos OnValidate acabou de ser executado");

3. Para adicionar código no VBScript, escreva XDocument.UI.Alert("O evento do nome do evento acabou de ser executado") Por exemplo, se adicionar este código ao processador de eventos OnSaveRequest , escreveria XDocument.UI.Alert("O processador de eventos OnSaveRequest acabou de ser executado")

4. Para testar o código, clique em Pré-visualizar no menu Ficheiro ou prima Ctrl+Shift+B e, em seguida, execute uma ação de utilizador que possa iniciar o evento. Quando o evento com a linha de código ocorre, uma caixa de mensagem deve apresentar a sua mensagem.

   Nota

   Alguns eventos podem exigir que publique o modelo de formulário e, em seguida, crie um formulário baseado neste modelo de formulário antes de poder efetuar uma ação de utilizador para iniciar o evento.

5. Antes de publicar o modelo de formulário e permitir que os seus utilizadores preencham formulários com base neste modelo de formulário, elimine o código que utilizou para apresentar a caixa de mensagem.

Início da Página

Adicionar um script que é executado quando um utilizador guarda os dados do formulário

1. No menu Ferramentas , clique em Opções de Formulário.

2. Na lista Categoria , na caixa de diálogo Opções de Formulário , clique em Abrir e Guardar.

3. Em Comportamento de guardar, selecione a caixa de verificação Guardar com código personalizado e, em seguida, clique em Editar. O Microsoft Script Editor começa com o cursor no processador de eventos OnSaveRequest.
   JScript

   //=======
   // The following function handler is created by Microsoft Office InfoPath.
   // Do not modify the name of the function, or the name and number of arguments.
   //=======
   function XDocument::OnSaveRequest(eventObj)
   {
      // Write the code to be run before saving here.
      eventObj.IsCancelled = eventObj.PerformSaveOperation();
      // Write the code to be run after saving here.
      eventObj.ReturnStatus = true;
   }
   
   

   VBScript

   '=======
   ' The following function handler is created by Microsoft Office InfoPath.
   ' Do not modify the name of the function, or the name and number of arguments.
   '=======
   Sub XDocument_OnSaveRequest(eventObj)
   ' Write the code to be run before saving here.
   eventObj.IsCancelled = eventObj.PerformSaveOperation
   ' Write the code to be run after saving here.
   eventObj.ReturnStatus = True
   End Sub
   
   

4. Siga um ou ambos os procedimentos que se seguem:

   • Para adicionar um script que é executado antes de o InfoPath guardar o formulário, substitua o comentário Write the code to be run before saving here.pelo seu código.
   • Para adicionar um script que é executado após o InfoPath guardar o formulário, substitua o comentário Write the code to be run after saving here. pelo seu código.

5. Para testar as suas alterações, clique em Pré-visualizar na barra de ferramentas Padrão ou prima CTRL+SHIFT+B.

   Nota

   Se o processador de eventos for executado apenas depois de criar um formulário com base no modelo de formulário, publique o modelo de formulário ao clicar em Publicar no menu Ficheiro e, em seguida, conclua o Assistente de Publicação. Depois de publicar o modelo de formulário, crie um formulário e, em seguida, execute uma ação para executar o processador de eventos.

Início da Página

Adicionar um script que é executado quando um utilizador submete os dados do formulário

1. No menu Ferramentas , clique em Opções de Submissão.

2. Na caixa de diálogo Opções de Submissão , selecione a caixa de verificação Permitir que os utilizadores submetam este formulário .

3. Clique em Executar ação personalizada com o Código e, em seguida, clique em Editar Código. O Microsoft Script Editor começa com o cursor no processador de eventos OnSubmitRequest.
   JScript

   //=======
   // The following function handler is created by Microsoft Office InfoPath.
   // Do not modify the name of the function, or the name and number of arguments.
   //=======
   function XDocument::OnSubmitRequest(eventObj)
   {
      // If the submit operation is successful, set
      // eventObj.ReturnStatus = true;
      // Write your code here
   }
   
   

   VBScript

   '=======
   ' The following function handler is created by Microsoft Office InfoPath.
   ' Do not modify the name of the function, or the name and number of arguments.
   '=======
   Sub XDocument_OnSubmitRequest(eventObj)
   ' If the submit operation is successful, set
   ' eventObj.ReturnStatus = True
   ' Write your code here
   End Sub
   
   

4. Substitua o comentário If the submit operation is successful, set eventObj.ReturnStatus = true Write your code here pelo seu código.

5. Para testar as suas alterações, clique em Pré-visualizar na barra de ferramentas Padrão ou prima CTRL+SHIFT+B.

Início da Página

Adicionar um script que é executado quando um utilizador clica num botão

1. Adicione um novo botão a uma vista no modelo de formulário e, em seguida, faça duplo clique no botão.

   Nota

   Se estiver a adicionar script a um botão existente, faça duplo clique no botão existente.

2. Clique no separador Geral.

3. Clique em Editar Código de Formulário. O Microsoft Script Editor começa com o cursor no processador de eventos OnClick para esse botão.
   JScript

   //=======
   // The following function handler is created by Microsoft Office InfoPath.
   // Do not modify the name of the function, or the name and number of arguments.
   //=======
   function Button Name::OnClick(eventObj)
   {
   // Write your code here
   }
   
   

   VBScript

   '=======
   ' The following function handler is created by Microsoft Office InfoPath.
   ' Do not modify the name of the function, or the name and number of arguments.
   '=======
   Sub Button Name_OnClick(eventObj)
   ' Write your code here
   End Sub
   
   

4. Substitua o comentário Write your code here pelo seu código.

5. Para testar as suas alterações, clique em Pré-visualizar na barra de ferramentas Padrão ou prima CTRL+SHIFT+B.

Início da Página

Adicionar um script que é executado quando os formulários existentes são intercalados

1. No menu Ferramentas , clique em Opções de Formulário.

2. Na lista Categoria , na caixa de diálogo Opções de Formulário , clique em Avançadas.

3. Em Intercalar formulários, selecione a caixa de verificação Ativar intercalação de formulários .

4. Selecione a caixa de verificação Intercalar utilizando código personalizado e, em seguida, clique em Editar. O Microsoft Script Editor começa com o cursor no processador de eventos OnMergeRequest.
   JScript

   //=======
   // The following function handler is created by Microsoft Office InfoPath.
   // Do not modify the name of the function, or the name and number of arguments.
   //=======
   function XDocument::OnMergeRequest(eventObj)
   {
   // Write the code that handles each form being merged here.
   XDocument.ImportDOM(eventObj.DOM);
   eventObj.ReturnStatus = true;
   }
   
   

   VBScript

   '=======
   ' The following function handler is created by Microsoft Office InfoPath.
   ' Do not modify the name of the function, or the name and number of arguments.
   '=======
   Sub XDocument_OnMergeRequest(eventObj)
   ' Write the code that handles each form being merged here.
   XDocument.ImportDOM(eventObj.DOM)
   eventObj.ReturnStatus = True
   End Sub
   
   

5. Substitua o comentário Write the code that handles each form being merged here. pelo seu código.

6. Para testar o código neste evento, publique o modelo de formulário, crie vários formulários com base neste modelo de formulário e, em seguida, intercale os modelos de formulário.

   Nota

   Encontre ligações para obter mais informações sobre a publicação do modelo de formulário na secção Consulte Também .

Início da Página

Adicionar um script para atualizar os formulários existentes

Se tiver atualizado um modelo de formulário publicado anteriormente e quiser atualizar os formulários existentes com base nesse modelo de formulário, pode adicionar script ao modelo de formulário atualizado que é executado quando um utilizador abre um dos formulários existentes. Quando um utilizador abre um formulário existente, o InfoPath verifica o número da versão do modelo de formulário associado na localização de publicação. Se o número da versão do modelo de formulário na localização de publicação for mais recente do que o número da versão no formulário existente, indicando que foi atualizado, o InfoPath executa o código neste evento para atualizar o formulário existente.

1. No menu Ferramentas , clique em Opções de Formulário.

2. Na lista Categoria , na caixa de diálogo Opções de Formulário , clique em Controlo de Versões.

3. Na lista Atualização da versão ativada, clique em Utilizar evento personalizado e, em seguida, clique em Editar. A Microsoft Script Editor começa com o cursor no processador de eventos OnVersionUpgrade.
   JScript

   //=======
   // The following function handler is created by Microsoft Office InfoPath.
   // Do not modify the name of the function, or the name and number of arguments.
   //=======
   function XDocument::OnVersionUpgrade(eventObj)
   {
   // Write your code here
   }
   
   

   VBScript

   '=======
   ' The following function handler is created by Microsoft Office InfoPath.
   ' Do not modify the name of the function, or the name and number of arguments.
   '=======
   Sub XDocument_OnVersionUpgrade(eventObj)
   ' Write your code here
   End Sub
   
   

4. Substitua o comentário Write your code here pelo seu código.

5. Para testar o código neste evento, publique o modelo de formulário, crie vários formulários com base neste modelo de formulário, modifique e publique uma versão atualizada do modelo de formulário e, em seguida, abra um formulário existente com base na versão mais antiga deste modelo de formulário.

   Nota

   Encontre ligações para obter mais informações sobre a publicação do modelo de formulário na secção Consulte Também .

Início da Página

Adicionar um script para outros eventos

Este procedimento pode ser utilizado para adicionar os seguintes processadores de eventos ao modelo de formulário:

• OnAfterChange
• OnBeforeChange
• OnContextChange
• OnLoad
• OnSwitchView
• OnSign
• OnValidate
• No menu Ferramentas , aponte para Programação e, em seguida, clique no evento para adicionar ao processador de eventos. A Microsoft Script Editor começa com o cursor no processador de eventos que selecionou.
• Substitua o comentário Write your code here pelo seu código.

Início da Página