RibbonButton 인터페이스
사용자 지정 리본 메뉴의 단추를 나타냅니다.
네임스페이스: Microsoft.Office.Tools.Ribbon
어셈블리: Microsoft.Office.Tools.Common(Microsoft.Office.Tools.Common.dll)
구문
‘선언
<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
RibbonButton 형식에서는 다음과 같은 멤버를 노출합니다.
속성
| 이름 | 설명 | |
|---|---|---|
.gif "Public 속성") |
ControlSize | 단추의 크기를 가져오거나 설정합니다. |
|
Description | 메뉴의 ItemSize 속성이 Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge로 설정된 경우 메뉴의 이 단추에 나타나는 텍스트를 가져오거나 설정합니다. |
|
Enabled | 이 RibbonControl이 활성화되는지 여부를 나타내는 값을 가져오거나 설정합니다. (RibbonControl에서 상속됨) |
|
Id | Microsoft Office에서 이 RibbonControl 개체를 식별하는 데 사용하는 문자열을 가져옵니다. (RibbonControl에서 상속됨) |
|
Image | 단추에 표시되는 이미지를 가져오거나 설정합니다. |
|
ImageName | LoadImage 이벤트 처리기에서 단추를 식별하는 데 사용할 수 있는 이름을 가져오거나 설정합니다. |
|
KeyTip | 단추의 바로 가기 키를 가져오거나 설정합니다. |
|
Label | 단추에 표시되는 텍스트를 가져오거나 설정합니다. |
|
Name | 이 RibbonComponent의 이름을 가져오거나 설정합니다. (RibbonComponent에서 상속됨) |
|
OfficeImageId | 기본 제공 Microsoft Office 아이콘을 사용하려는 경우 단추에 표시할 이미지를 가져오거나 설정합니다. |
|
Parent | 이 RibbonComponent의 부모를 나타내는 RibbonComponent를 가져옵니다. (RibbonComponent에서 상속됨) |
|
Position | 단추가 Microsoft Office 메뉴에 있는 경우 해당 단추의 위치를 가져오거나 설정합니다. |
|
Ribbon | 컨트롤 계층 구조가 들어 있는 최상위 Ribbon 개체를 가져옵니다. (RibbonComponent에서 상속됨) |
|
RibbonUI | 인프라입니다. Microsoft Office 응용 프로그램에서 리본 확장성 코드에 제공하는 IRibbonUI 인스턴스를 가져옵니다. (RibbonComponent에서 상속됨) |
|
ScreenTip | 포인터를 단추 위로 이동할 때 나타나는 도구 설명 텍스트를 가져오거나 설정합니다. |
|
ShowImage | 단추에 연결된 이미지가 표시되는지 여부를 나타내는 값을 가져오거나 설정합니다. |
|
ShowLabel | 단추의 레이블이 표시되는지 여부를 나타내는 값을 가져오거나 설정합니다. |
|
Site | IComponent 와 관련된 ISite를 가져오거나 설정합니다. (IComponent에서 상속됨) |
|
SuperTip | 포인터를 단추 위로 이동할 때 나타나는 여러 줄 팁 텍스트를 가져오거나 설정합니다. |
|
Tag | 이 RibbonComponent와 연결된 응용 프로그램별 데이터를 가져오거나 설정합니다. (RibbonComponent에서 상속됨) |
|
Visible | 이 RibbonControl이 표시되는지 여부를 나타내는 값을 가져오거나 설정합니다. (RibbonControl에서 상속됨) |
위쪽
메서드
| 이름 | 설명 | |
|---|---|---|
.gif "Public 메서드") |
Dispose | 관리되지 않는 리소스의 확보, 해제 또는 다시 설정과 관련된 응용 프로그램 정의 작업을 수행합니다. (IDisposable에서 상속됨) |
|
PerformDynamicLayout | RibbonComponent 에 동적 메뉴와 같은 동적 부모가 있고 레이아웃이 일시 중단되지 않은 경우 부모 컨트롤의 Microsoft.Office.Core.IRibbonUI.InvalidateControl 메서드를 호출합니다. (RibbonComponent에서 상속됨) |
|
PerformLayout | RibbonComponent 에 부모가 있고 레이아웃이 일시 중단되지 않은 경우 Microsoft.Office.Core.IRibbonUI.InvalidateControl을 호출합니다. (RibbonComponent에서 상속됨) |
|
ResumeLayout() | SuspendLayout 메서드의 결과를 되돌립니다. (RibbonComponent에서 상속됨) |
|
ResumeLayout(Boolean) | SuspendLayout 메서드의 결과를 되돌립니다. (RibbonComponent에서 상속됨) |
|
SuspendLayout | Microsoft Office 응용 프로그램에서 리본 메뉴의 컨트롤 상태를 새로 고치지 않도록 합니다. (RibbonComponent에서 상속됨) |
위쪽
이벤트
| 이름 | 설명 | |
|---|---|---|
.gif "Public 이벤트") |
Click | 사용자가 단추를 클릭할 때 발생합니다. |
|
Disposed | 구성 요소의 Disposed 이벤트를 처리하는 메서드를 나타냅니다. (IComponent에서 상속됨) |
위쪽
설명
Visual Studio는 도구 상자의 Office 리본 컨트롤탭에서 단추 컨트롤을 리본 디자이너로 끌어올 경우 RibbonButton 인터페이스를 구현하는 클래스의 인스턴스를 만듭니다.
런타임에 이 컨트롤의 인스턴스를 만들어 동적 메뉴에 추가할 수도 있습니다.Dynamic 속성이 true로 설정된 메뉴가 동적 메뉴입니다.
이 컨트롤의 일부 속성은 Office 응용 프로그램에 리본 메뉴가 로드되기 전 또는 런타임에 동적 메뉴에 컨트롤이 추가되기 전에만 설정할 수 있습니다.이러한 속성 설정에 대한 자세한 내용은 리본 개체 모델 개요를 참조하십시오.
RibbonFactory 개체의 CreateRibbonButton 메서드를 사용하여 런타임에 RibbonButton를 만들 수 있습니다.
다음과 같은 두 가지 방법으로 RibbonFactory 개체에 액세스할 수 있습니다.
리본 클래스의 Factory 속성을 사용합니다.리본 클래스 내부의 코드에서 이 방법을 사용합니다.
Globals.Factory.GetRibbonFactory 메서드를 사용합니다.리본 클래스 외부의 코드에서 이 방법을 사용합니다.
일반 작업
다음 표에서는 일반적인 작업에 유용한 멤버를 보여 줍니다.
Task |
멤버 |
|---|---|
런타임에 Dynamic 속성이 true로 설정된 메뉴에 단추를 추가합니다. |
CreateRibbonButton을 사용하여 RibbonButton 인터페이스를 구현하는 클래스의 인스턴스를 만듭니다. RibbonFactory 클래스의 메서드자세한 내용은 Office 프로젝트의 개체에 전역 액세스을 참조하십시오. 메뉴의 Items 컬렉션에 인스턴스를 추가합니다. |
단추의 크기를 변경합니다. |
ControlSize를 원하는 값으로 설정합니다.예를 들어 큰 단추의 경우 이 속성을 Microsoft.Office.Core.RibbonControlSize.RibbonControlSizeLarge로 설정합니다. |
단추에 이미지를 표시합니다. |
이미지를 표시하는 방법에는 다음과 같은 세 가지가 있습니다.
|
단추를 비활성화하거나 숨깁니다. |
단추를 비활성화하려면 Enabled를 false로 설정합니다. 단추를 숨기려면 Visible를 false로 설정합니다. |
사용자가 단추를 클릭할 때 코드를 실행합니다. |
Click 이벤트 처리기에 코드를 추가합니다. |
[!참고]
이 인터페이스는 Visual Studio Tools for Office Runtime에 의해 구현되며 코드에서 직접 구현할 수는 없습니다. 자세한 내용은 Visual Studio Tools for Office 런타임 개요를 참조하십시오.
용도
이 설명서에서는 .NET Framework 4 및 .NET Framework 4.5를 대상으로 하는 Office 프로젝트에서 사용되는 이 형식의 버전에 대해 설명합니다. .NET Framework 3.5를 대상으로 하는 프로젝트에서는 이 형식의 멤버가 다를 수 있으며 이 형식을 위해 제공되는 코드 예제가 작동하지 않을 수도 있습니다. .NET Framework 3.5를 대상으로 하는 프로젝트의 이 형식에 대한 문서는 Visual Studio 2008 설명서의 다음 참조 섹션을 참조하십시오. https://go.microsoft.com/fwlink/?LinkId=160658.
예제
다음 예제에서는 새 단추를 만들고 단추의 여러 속성을 설정한 다음 해당 단추를 메뉴에 추가합니다.이 코드 예제를 실행하려면 먼저 다음 단계를 수행해야 합니다.
리본(비주얼 디자이너) 항목을 Visual Studio에 있는 Office 개발 도구를 사용하여 만든 프로젝트에 추가합니다.
그룹을 사용자 지정 탭에 추가합니다.
그룹에 메뉴를 추가합니다.
메뉴의 Dynamic 속성을 true로 설정합니다.
메뉴의 ItemSize 속성을 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);
}
참고 항목
참조
Microsoft.Office.Tools.Ribbon 네임스페이스
RibbonButton