Método ControlExtensions.AddRichTextBox (ControlCollection, Range, String)
Adiciona um novo RichTextBox o controle para a planilha no intervalo especificado.
Namespace: Microsoft.Office.Tools.Excel
Assembly: Microsoft.Office.Tools.Excel.v4.0.Utilities (em Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)
Sintaxe
'Declaração
<ExtensionAttribute> _
Public Shared Function AddRichTextBox ( _
controls As ControlCollection, _
range As Range, _
name As String _
) As RichTextBox
public static RichTextBox AddRichTextBox(
this ControlCollection controls,
Range range,
string name
)
Parâmetros
- controls
Tipo: Microsoft.Office.Tools.Excel.ControlCollection
A coleção para adicionar o controle.Não forneça esse parâmetro sozinho.Quando você chamar esse método na coleção retornada com o Worksheet.Controls propriedade (em um projeto de nível de aplicativo) ou o WorksheetBase.Controls propriedade (em um projeto de nível de documento), este parâmetro é fornecido automaticamente.
- range
Tipo: Microsoft.Office.Interop.Excel.Range
A Range que fornece os limites para o controle.
- name
Tipo: System.String
O nome do controle que pode ser usado para indexar o controle de ControlCollection instância.
Valor de retorno
Tipo: Microsoft.Office.Tools.Excel.Controls.RichTextBox
O RichTextBox controle foi adicionado para o ControlCollection instância.
Observação de uso
No Visual Basic e no C#, você pode chamar esse método como um método de instância em qualquer objeto do tipo ControlCollection. Quando você usar a sintaxe de método de instância para chamar esse método, omita o primeiro parâmetro. Para obter mais informações, consulte Métodos de extensão (Visual Basic) ou Métodos de extensão (guia de programação TRANSLATION FROM VPE FOR CSHARP).
Exceções
| Exceção | Condição |
|---|---|
| ArgumentNullException | O argumento do nome ou o intervalo é nulluma referência nula (Nothing no Visual Basic), ou o argumento nome tem comprimento zero. |
| ControlNameAlreadyExistsException | Um controle com o mesmo nome já está na ControlCollection instância. |
| InvalidRangeException | O intervalo especificado não é válido. Intervalos de múltiplas áreas não podem ser usados. O intervalo deve estar na mesma planilha como o ControlCollection instância. |
Comentários
O AddRichTextBox método permite que você adicione RichTextBox objetos no final da ControlCollection. Para remover um RichTextBox que foi previamente adicionado programaticamente, use o Remove método.
O controle é redimensionado automaticamente quando o intervalo é redimensionado.
Exemplos
O exemplo de código a seguir adiciona um RichTextBox controle às células A1 por B2, atribui um texto para o controle e, em seguida, formata o texto. Para usar esse exemplo, executá-lo do Sheet1 a classe em um projeto de nível de documento.
Private Sub ExcelRangeAddRichTextBox()
Dim RichTextBox1 As Microsoft.Office.Tools. _
Excel.Controls.RichTextBox = Me.Controls. _
AddRichTextBox(Me.Range("A1", "B2"), _
"RichTextBox1")
RichTextBox1.Text = "Sample text"
RichTextBox1.Select(0, 6)
RichTextBox1.SelectionFont = New Font( _
"Times New Roman", 10, FontStyle.Bold)
End Sub
private void ExcelRangeAddRichTextBox()
{
Microsoft.Office.Tools.Excel.Controls.RichTextBox
richTextBox1 = this.Controls.AddRichTextBox(
this.Range["A1", "B2"], "richTextBox1");
richTextBox1.Text = "Sample text";
richTextBox1.Select(0, 6);
richTextBox1.SelectionFont = new Font("Times New Roman",
10, FontStyle.Bold);
}
Segurança do .NET Framework
- Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.