Interfaccia RibbonButton

Articolo
08/11/2011

Rappresenta un pulsante in una barra multifunzione personalizzata.

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

Sintassi

'Dichiarazione
<GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")> _
Public Interface RibbonButton _
    Inherits RibbonControl, RibbonComponent, IComponent, IDisposable

[GuidAttribute("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : RibbonControl, 
    RibbonComponent, IComponent, IDisposable

Il tipo RibbonButton espone i seguenti membri.

Proprietà

	Nome	Descrizione
	ControlSize	Ottiene o imposta le dimensioni del pulsante.
	Description	Ottiene o imposta il testo visualizzato nel pulsante in un menu quando la proprietà ItemSize del menu è impostata su Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
	Enabled	Ottiene o imposta un valore che indica se l'oggetto RibbonControl è abilitato. (Ereditato da RibbonControl)
	Id	Ottiene una stringa utilizzata da Microsoft Office per identificare l'oggetto RibbonControl. (Ereditato da RibbonControl)
	Image	Ottiene o imposta l'immagine visualizzata nel pulsante.
	ImageName	Ottiene o imposta il nome utilizzabile per identificare il pulsante nel gestore eventi LoadImage.
	KeyTip	Ottiene o imposta il tasto di scelta rapida per il pulsante.
	Label	Ottiene o imposta il testo visualizzato nel pulsante.
	Name	Ottiene o imposta il nome di RibbonComponent. (Ereditato da RibbonComponent)
	OfficeImageId	Ottiene o imposta l'immagine da visualizzare nel pulsante se si desidera utilizzare un'icona incorporata di Microsoft Office.
	Parent	Ottiene un oggetto RibbonComponent che rappresenta l'elemento padre di RibbonComponent. (Ereditato da RibbonComponent)
	Position	Ottiene o imposta la posizione del pulsante, se questo è incluso nel menu Microsoft Office.
	Ribbon	Ottiene l'oggetto Ribbon di primo livello contenente la gerarchia dei controlli. (Ereditato da RibbonComponent)
	RibbonUI	Infrastruttura. Ottiene l'istanza di IRibbonUI fornita dall'applicazione Microsoft Office al codice di estensibilità della barra multifunzione. (Ereditato da RibbonComponent)
	ScreenTip	Ottiene o imposta il testo della descrizione comandi visualizzata quando il puntatore del mouse viene passato sul pulsante.
	ShowImage	Ottiene o imposta un valore che indica se l'immagine associata al pulsante è visibile o meno.
	ShowLabel	Ottiene o imposta un valore che indica se l'etichetta del pulsante è visibile o meno.
	Site	Ottiene o imposta l'oggetto ISite associato a IComponent. (Ereditato da IComponent)
	SuperTip	Ottiene o imposta il testo del suggerimento su più righe visualizzato quando il puntatore del mouse viene passato sul pulsante.
	Tag	Ottiene o imposta dati specifici dell'applicazione associati a RibbonComponent. (Ereditato da RibbonComponent)
	Visible	Ottiene o imposta un valore che indica se RibbonControl è visibile. (Ereditato da RibbonControl)

In alto

Metodi

	Nome	Descrizione
	Dispose	Esegue attività definite dall'applicazione, ad esempio libera, rilascia o reimposta risorse non gestite. (Ereditato da IDisposable)
	PerformDynamicLayout	Chiama il metodo Microsoft.Office.Core.IRibbonUI.InvalidateControl del controllo padre se l'oggetto RibbonComponent dispone di un elemento padre dinamico, ad esempio un menu dinamico, e il layout non è sospeso. (Ereditato da RibbonComponent)
	PerformLayout	Effettua la chiamata a Microsoft.Office.Core.IRibbonUI.InvalidateControl se RibbonComponent dispone di un elemento padre e il layout non è sospeso. (Ereditato da RibbonComponent)
	ResumeLayout()	Inverte l'effetto del metodo SuspendLayout. (Ereditato da RibbonComponent)
	ResumeLayout(Boolean)	Inverte l'effetto del metodo SuspendLayout. (Ereditato da RibbonComponent)
	SuspendLayout	Impedisce all'applicazione di Microsoft Office di aggiornare lo stato dei controlli nella barra multifunzione. (Ereditato da RibbonComponent)

In alto

Eventi

	Nome	Descrizione
	Click	Si verifica quando viene fatto clic sul pulsante.
	Disposed	Rappresenta il metodo che gestisce l'evento Disposed di un componente. (Ereditato da IComponent)

In alto

Note

Quando si trascina un controllo Button dalla scheda Controlli barra multifunzione di Office della Casella degli strumenti alla finestra di progettazione della barra multifunzione, Visual Studio crea un'istanza di una classe che implementa l'interfaccia 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.

È possibile creare RibbonButton in fase di esecuzione tramite il metodo CreateRibbonButton dell'oggetto RibbonFactory.

Sono disponibili due modi per accedere all'oggetto RibbonFactory:

Mediante la proprietà Factory della classe Ribbon. Utilizzare questo approccio dal codice della classe Ribbon.
Mediante il metodo Globals.Factory.GetRibbonFactory. Utilizzare questo approccio dal codice all'esterno della classe Ribbon.

Attività comuni

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

Task	Membro
In fase di esecuzione, aggiungere un pulsante a un menu la cui proprietà Dynamic è impostata su true.	Creare un'istanza di una classe che implementa l'interfaccia RibbonButton utilizzando CreateRibbonButton metodo della classe RibbonFactory. Per ulteriori informazioni, vedere Accesso globale a oggetti nei progetti di Office. 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.
Disabilitare o nascondere pulsanti.	Per disabilitare 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.

Nota

Questa interfaccia è implementata da Visual Studio Tools per Office Runtime. Non deve essere implementata nel codice. Per ulteriori informazioni, vedere Cenni preliminari su Visual Studio Tools per Office Runtime.

Utilizzo

Nella presente documentazione viene descritta la versione di questo tipo utilizzata nei progetti di Office destinati a .NET Framework 4. Nei progetti destinati a .NET Framework 3.5, questo tipo potrebbe avere membri diversi e gli esempi di codice forniti per il tipo potrebbero non funzionare. Per la documentazione relativa a questo tipo nei progetti destinati a .NET Framework 3.5, vedere la sezione di riferimento seguente nella documentazione di Visual Studio 2008: https://go.microsoft.com/fwlink/?LinkId=160658.

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 creato utilizzando gli strumenti di sviluppo Office di Visual Studio.
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 = Me.Factory.CreateRibbonButton()
    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 = this.Factory.CreateRibbonButton();
    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);

}