Classe RibbonButton (System 2007)

Articolo
09/12/2008

Aggiornamento: novembre 2007

Rappresenta un pulsante in una barra multifunzione personalizzata.

Spazio dei nomi: Microsoft.Office.Tools.Ribbon
Assembly: Microsoft.Office.Tools.Common.v9.0 (in Microsoft.Office.Tools.Common.v9.0.dll)

Sintassi

<ToolboxBitmapAttribute(GetType(RibbonButton), "RibbonButton.bmp")> _
Public NotInheritable Class RibbonButton _
    Inherits RibbonControl

Dim instance As RibbonButton

[ToolboxBitmapAttribute(typeof(RibbonButton), "RibbonButton.bmp")]
public sealed class RibbonButton : RibbonControl

Note

Quando un controllo Button viene trascinato dalla scheda Controlli barra multifunzione di Office della Casella degli strumenti alla finestra di progettazione della barra multifunzione, in Visual Studio Tools per Office viene creata un'istanza della classe RibbonButton.

In alternativa è possibile creare un'istanza di questo controllo in fase di esecuzione e aggiungerla a un menu dinamico. Un menu viene considerato dinamico se la relativa proprietà Dynamic è impostata su true.

Alcune proprietà di questo controllo possono essere impostate soltanto prima che la barra multifunzione venga caricata nell'applicazione di Office o prima che il controllo venga aggiunto a un menu dinamico in fase di esecuzione. Per ulteriori informazioni sull'impostazione di tali proprietà, vedere Cenni preliminari sul modello a oggetti della barra multifunzione.

Attività comuni

Nella tabella riportata di seguito sono elencati membri utili per le attività comuni,

Attività	Membro
In fase di esecuzione, aggiungere un pulsante a un menu la cui proprietà Dynamic è impostata su true.	Creare un'istanza della classe RibbonButton utilizzando il costruttore RibbonButton. Aggiungere l'istanza all'insieme Items del menu.
Modificare le dimensioni del pulsante.	Impostare ControlSize sul valore desiderato. Per un pulsante di grandi dimensioni, ad esempio, impostare l'oggetto su Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Visualizzare un'immagine nel pulsante.	Per visualizzare un'immagine, è possibile procedere in tre modi: Utilizzare la proprietà Image. Tale proprietà garantisce il livello di controllo più elevato. Impostare OfficeImageId sull'ID di un'immagine incorporata di Microsoft Office da visualizzare come icona del pulsante. Utilizzare la proprietà ImageName con l'evento LoadImage. Tale proprietà garantisce alcuni vantaggi a livello di prestazioni.
Disattivare o nascondere pulsanti.	Per disattivare un pulsante, impostare Enabled su false. Per nascondere un pulsante, impostare Visible su false.
Eseguire codice quando viene fatto clic sul pulsante.	Aggiungere codice al gestore eventi Click.

Esempi

Nell'esempio riportato di seguito viene illustrato come creare un nuovo pulsante, impostarne varie proprietà e aggiungerlo quindi a un menu. Per eseguire questo esempio di codice, effettuare innanzitutto le seguenti operazioni:

Aggiungere un elemento Barra multifunzione (finestra di progettazione visiva) a un progetto Visual Studio Tools per Office.
Aggiungere un gruppo alla scheda personalizzata.
Aggiungere un menu al gruppo.
Impostare la proprietà Dinamico del menu su true.
Impostare la proprietà ItemSize del menu su RibbonControlSizeLarge.

Private Sub AddButtonsToMenu()
    Dim tempButton As New RibbonButton()
    tempButton.Label = "Button 1"
    tempButton.ControlSize = _
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge
    tempButton.Description = "My Ribbon Button"
    tempButton.ShowImage = True
    tempButton.ShowImage = True
    tempButton.Image = My.Resources.Image1
    tempButton.Image = My.Resources.Image2
    tempButton.KeyTip = "A1"
    menu1.Items.Add(tempButton)
End Sub

private void AddButtonsToMenu()
{
    RibbonButton tempButton = new RibbonButton();
    tempButton.Label = "Button 1";
    tempButton.ControlSize = 
        Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge;
    tempButton.Description = "My Ribbon Button";
    tempButton.ShowImage = true;
    tempButton.ShowImage = true;
    tempButton.Image = Properties.Resources.Image1;
    tempButton.Image = Properties.Resources.Image2;
    tempButton.KeyTip = "A1";
    menu1.Items.Add(tempButton);

}