Compartilhar via


Parâmetros opcionais em soluções do Office

Muitos dos métodos nos modelos de objeto dos aplicativos de Microsoft Office aceitam parâmetros opcionais. Se você usar Visual Basic para desenvolver uma solução do Office em Visual Studio 2010, não é necessário passar um valor para os parâmetros opcionais, porque os valores padrão são usados automaticamente para cada parâmetro ausente. Na maioria dos casos, você também pode omitir os parâmetros opcionais em projetos do Visual C#. Entretanto, você não pode omitir opcional ref parâmetros da ThisDocument classe no nível do documento Word projetos.

Aplicável a: As informações neste tópico se aplicam a projetos de nível de documento e projetos de nível de aplicativo para Microsoft Office 2010 e o sistema 2007 do Microsoft Office. Para obter mais informações, consulte Recursos disponíveis pelo aplicativo do Office e o tipo de projeto.

Para obter mais informações sobre como trabalhar com parâmetros opcionais em projetos do Visual C# e Visual Basic, consulte Nome e argumentos Opcional (guia de programação de C#) e Parâmetros opcionais (Visual Basic).

ObservaçãoObservação

Em versões anteriores do Visual Studio, você deve passar um valor para cada parâmetro opcional em projetos do Visual C#. Para sua conveniência, esses projetos incluem uma variável global chamada missing que você pode passar para um parâmetro opcional quando você desejar usar o valor padrão do parâmetro. Projetos do Visual C# para o Office em Visual Studio 2010 ainda incluem o missing variável, mas você normalmente não precisará usá-lo ao desenvolver soluções do Office em Visual Studio 2010, exceto quando você chamar métodos com opcional ref parâmetros na ThisDocument classe nos projetos de nível de documento para Word.

Exemplo do Excel

O Worksheet.CheckSpelling método tem muitos parâmetros opcionais. Você pode especificar valores para alguns parâmetros e aceite o valor padrão de outras pessoas, como mostrado no exemplo de código a seguir. Este exemplo requer um projeto de nível de documento com uma classe de planilha chamada Sheet1.

Globals.Sheet1.CheckSpelling(ignoreUppercase:=True)
// In projects that target the .NET Framework 3.5, change "ignoreUppercase" to "IgnoreUppercase" 
// in the following line of code.
Globals.Sheet1.CheckSpelling(ignoreUppercase: true);

Exemplo no Word

O Find.Execute método tem muitos parâmetros opcionais. Você pode especificar valores para alguns parâmetros e aceite o valor padrão de outras pessoas, como mostrado no exemplo de código a seguir.

With Me.Application.ActiveDocument.Content
    .Find.ClearFormatting()
    .Find.Execute(FindText:="blue", ReplaceWith:="red", Replace:=Word.WdReplace.wdReplaceAll)
End With
Word.Range documentRange = this.Application.ActiveDocument.Content;
documentRange.Find.ClearFormatting();
documentRange.Find.Execute(FindText: "blue", ReplaceWith: "red", Replace: Word.WdReplace.wdReplaceAll);            

Usando os parâmetros opcionais dos métodos na classe ThisDocument em projetos do Visual C# nível de documento do Word

O modelo de objeto do Word contém muitos métodos com opcional ref que aceitam parâmetros de Object valores. Entretanto, você não pode omitir opcional ref parâmetros de métodos de gerado ThisDocument classe no Visual C# projetos de nível de documento para Word. C# Visual permite omitir opcional ref parâmetros somente para os métodos das interfaces, classes. Por exemplo, o exemplo de código a seguir não compila, porque você não pode omitir opcional ref parâmetros da CheckSpelling método o ThisDocument classe.

Globals.ThisDocument.CheckSpelling(ignoreUppercase: true);

Quando você chamar métodos para a ThisDocument da classe, siga estas diretrizes:

  • Para aceitar o valor padrão de um recurso opcional ref parâmetro, passar o missing variável para o parâmetro. O missing variável é definida automaticamente em projetos do Visual C# Office e é atribuído o valor Type.Missing no código gerado do projeto.

  • Para especificar seu próprio valor para um recurso opcional ref parâmetro, declarar um objeto que é atribuído o valor que você deseja especificar e em seguida, passar o objeto para o parâmetro.

O exemplo de código a seguir demonstra como chamar o CheckSpelling método especificando um valor para o ignoreUppercase parâmetro e aceitar o valor padrão para outros parâmetros.

object ignoreUppercase = true;
Globals.ThisDocument.CheckSpelling(
    ref missing, ref ignoreUppercase, ref missing, ref missing, ref missing, ref missing,
    ref missing, ref missing, ref missing, ref missing, ref missing, ref missing);

Se você quiser escrever código que omite opcional ref parâmetros de um método na ThisDocument classe, você pode também chamar o mesmo método na Microsoft.Office.Interop.Word.Document objeto retornado pela InnerObject propriedade e omitir os parâmetros do método. Você pode fazer isso porque Microsoft.Office.Interop.Word.Document é uma interface em vez de uma classe.

Globals.ThisDocument.InnerObject.CheckSpelling(IgnoreUppercase: true);

Para obter mais informações sobre os parâmetros de tipo de referência e valor, consulte Passando argumentos por valor e por referência (Visual Basic) (para Visual Basic) e Passando parâmetros (guia de programação de C#).

Consulte também

Conceitos

Escrevendo código em soluções do Office

Outros recursos

Desenvolvimento de soluções do Office