RibbonButton Interfaccia

Definizione

Spazio dei nomi:

Microsoft.Office.Tools.Ribbon

Assembly:

Microsoft.Office.Tools.Common.dll

Rappresenta un pulsante in una barra multifunzione personalizzata.

public interface class RibbonButton : IDisposable, Microsoft::Office::Tools::Ribbon::RibbonControl, System::ComponentModel::IComponent

[System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")]
public interface RibbonButton : IDisposable, Microsoft.Office.Tools.Ribbon.RibbonControl, System.ComponentModel.IComponent

[<System.Runtime.InteropServices.Guid("b57e6217-33f2-46bf-9625-c313526de60c")>]
type RibbonButton = interface
    interface RibbonControl
    interface RibbonComponent
    interface IComponent
    interface IDisposable

Public Interface RibbonButton
Implements IComponent, IDisposable, RibbonControl

Attributi

GuidAttribute

Implementazioni

RibbonComponent RibbonControl IComponent IDisposable

Esempio

Nell'esempio seguente viene creato un nuovo pulsante, vengono impostate varie proprietà del pulsante e quindi viene aggiunto il pulsante a un menu. Per eseguire questo esempio di codice, è necessario eseguire prima i passaggi seguenti:

1. Aggiungere un elemento della barra multifunzione (Visual Designer) a un progetto creato usando gli strumenti di sviluppo di Office in Visual Studio.

2. Aggiungere un gruppo alla scheda personalizzata.

3. Aggiungere un menu al gruppo.

4. Impostare la proprietà Dynamic del menu su true.

5. Impostare la proprietà ItemSize del menu su RibbonControlSizeLarge.

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);

}

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

Commenti

Visual Studio crea un'istanza di una classe che implementa l'interfaccia RibbonButton quando si trascina un controllo Pulsante dalla scheda Controlli della barra multifunzione di Office della casella degli strumenti nella barra multifunzione Designer.

È anche possibile creare un'istanza di questo controllo in fase di esecuzione e aggiungerla a un menu dinamico. Un menu è dinamico se si imposta la relativa Dynamic proprietà su true.

Alcune proprietà di questo controllo possono essere impostate solo 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 informazioni sull'impostazione di queste proprietà, vedere Panoramica del modello a oggetti della barra multifunzione.

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

Sono disponibili due modi per accedere all'oggetto RibbonFactory:

• Usando la proprietà Factory della classe Ribbon. Usare questo approccio dal codice della classe Ribbon.

• Usando il metodo Globals.Factory.GetRibbonFactory. Usare questo approccio dal codice all'esterno della classe Ribbon.

Attività comuni

Nella tabella seguente sono elencati i membri utili per le attività comuni.

Attività	Membro
In fase di esecuzione aggiungere un pulsante a un menu con la relativa Dynamic proprietà impostata su true.	Creare un'istanza di una classe che implementa l'interfaccia RibbonButton usando CreateRibbonButton metodo della RibbonFactory classe . Per altre informazioni, vedere Accesso globale agli oggetti nei progetti di Office. Aggiungere l'istanza alla raccolta del Items menu.
Modificare le dimensioni del pulsante.	Impostare ControlSize sul valore desiderato. Ad esempio, per un pulsante di grandi dimensioni, impostarlo su Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge.
Visualizzare un'immagine sul pulsante.	Esistono tre modi per visualizzare un'immagine: - Usare la Image proprietà . Questa proprietà fornisce il controllo più controllo. - Impostare OfficeImageId sull'ID di un'immagine di Microsoft Office predefinita da visualizzare come icona per il pulsante. - Usare la ImageName proprietà insieme all'evento LoadImage . Questa proprietà offre alcuni vantaggi in termini di prestazioni.
Disabilitare o nascondere i pulsanti.	Per disabilitare un pulsante, impostare su Enabledfalse. Per nascondere un pulsante, impostare su Visiblefalse.
Eseguire il codice quando un utente fa clic sul pulsante.	Aggiungere codice al Click gestore eventi.

Nota

Questa interfaccia è implementata da Visual Studio Tools per Office Runtime. Non deve essere implementata nel codice. Per altre informazioni, vedere Visual Studio Tools for Office Runtime Overview.

Utilizzo

In questa documentazione viene descritta la versione di questo tipo usata nei progetti Office destinati a .NET Framework 4 o versione successiva. 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: http://go.microsoft.com/fwlink/?LinkId=160658.

Proprietà

ControlSize	Ottiene o imposta le dimensioni del pulsante.
Description	Ottiene o imposta il testo visualizzato in questo pulsante in un menu quando la ItemSize proprietà del menu è impostata su Microsoft.Office.Core.RibbonControlSize.RibbonControlSize.RibbonControlSizeLarge.
Enabled	Ottiene o imposta un valore che indica se RibbonControl è abilitato. (Ereditato da RibbonControl)
Id	Ottiene una stringa usata da Microsoft Office per identificare questo oggetto RibbonControl. (Ereditato da RibbonControl)
Image	Ottiene o imposta l'immagine visualizzata nel pulsante.
ImageName	Ottiene o imposta il nome che si può usare per identificare il pulsante nel gestore eventi LoadImage.
KeyTip	Ottiene o imposta il tasto di scelta rapida del 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 vuole usare un'icona predefinita 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 che contiene la gerarchia del controllo. (Ereditato da RibbonComponent)
RibbonUI	Ottiene l'istanza di IRibbonUI definita dall'applicazione Microsoft Office per il codice di estendibilità della barra multifunzione. (Ereditato da RibbonComponent)
ScreenTip	Ottiene o imposta il testo della descrizione comando 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.
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)

Metodi

PerformDynamicLayout()	Chiama il metodo Microsoft.Office.Core.IRibbonUI.InvalidateControl del controllo padre se RibbonComponent ha un elemento padre dinamico, ad esempio un menu dinamico, e il layout non è sospeso. (Ereditato da RibbonComponent)
PerformLayout()	Chiama Microsoft.Office.Core.IRibbonUI.InvalidateControl se RibbonComponent ha 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)

Eventi

Click

Si verifica quando viene fatto clic sul pulsante.