Ribbon XML

아티클
06/19/2023

리본(XML) 항목을 사용하면 XML을 통해 리본을 사용자 지정할 수 있습니다. 리본(비주얼 디자이너) 항목에서 지원하지 않는 방법으로 리본을 사용자 지정하려는 경우 리본(XML) 항목을 사용합니다. 각 항목에서 수행할 수 있는 비교는 리본 개요를 참조하세요.

적용 대상: 이 항목의 정보는 Excel, InfoPath 2013, InfoPath 2010, Outlook, PowerPoint, Project, Visio, Word와 같은 애플리케이션의 문서 수준 프로젝트 및 VSTO 추가 기능 프로젝트에 적용됩니다. 자세한 내용은 Office 애플리케이션 및 프로젝트 형식에 따라 사용 가능한 기능을 참조하세요.

프로젝트에 리본(XML) 항목 추가

새 항목 추가 대화 상자에서 Office 프로젝트에 리본(XML) 항목을 추가할 수 있습니다. Visual Studio에서 자동으로 다음 파일을 프로젝트에 추가합니다.

리본 XML 파일. 이 파일에서는 리본 UI(사용자 인터페이스)를 정의합니다. 이 파일을 사용하여 탭, 그룹 및 컨트롤과 같은 UI 요소를 추가할 수 있습니다. 자세한 내용은 이 항목의 뒷부분에 있는 리본 XML 파일 참조를 참조하세요.
리본 코드 파일. 이 파일에는 리본 클래스가 포함되어 있습니다. 이 클래스는 새 항목 추가 대화 상자에서 리본(XML) 항목에 대해 지정한 이름을 사용합니다. Microsoft Office 애플리케이션은 이 클래스의 인스턴스를 사용하여 사용자 지정 리본을 로드합니다. 자세한 내용은 이 항목의 뒷부분에 있는 리본 클래스 참조를 참조하세요.

기본적으로 이러한 파일은 리본의 추가 기능 탭에 사용자 지정 그룹을 추가합니다.

Microsoft Office 애플리케이션에서 사용자 지정 리본 표시

프로젝트에 리본(XML) 항목을 추가한 후 CreateRibbonExtensibilityObject 메서드를 재정의하고 Office 애플리케이션에 리본 XML 클래스를 반환하는 코드를 ThisAddin, ThisWorkbook 또는 ThisDocument 클래스에 추가해야 합니다.

다음 코드 예제에서는 CreateRibbonExtensibilityObject 메서드를 재정의하고 MyRibbon이라는 리본 XML 클래스를 반환합니다.

protected override Microsoft.Office.Core.IRibbonExtensibility CreateRibbonExtensibilityObject()
{
    return new MyRibbon();
}

Protected Overrides Function CreateRibbonExtensibilityObject() As  _
Microsoft.Office.Core.IRibbonExtensibility
    Return New MyRibbon()
End Function

사용자 지정 리본의 동작 정의

콜백 메서드를 만들어 리본에서 단추를 클릭하는 등의 사용자 작업에 응답할 수 있습니다. 콜백 메서드는 Windows Forms 컨트롤의 이벤트와 비슷하지만 UI 요소의 XML에서 특성으로 식별됩니다. 리본 클래스에서 메서드를 작성하고 컨트롤이 특성 값과 동일한 이름을 가진 메서드를 호출합니다. 예를 들어 사용자가 리본의 단추를 클릭할 때 호출되는 콜백 메서드를 만들 수 있습니다. 콜백 메서드를 만들려면 다음 두 단계가 필요합니다.

리본 XML 파일의 컨트롤에 코드에서 콜백 메서드를 식별하는 특성을 할당합니다.
리본 클래스에서 콜백 메서드를 정의합니다.

참고 항목

Outlook에는 추가 단계가 필요합니다. 자세한 내용은 Outlook용 리본 사용자 지정을 참조하세요.

리본에서 애플리케이션을 자동화하는 방법을 보여 주는 연습은 연습: 리본 XML을 사용하여 사용자 지정 탭 만들기를 참조하세요.

컨트롤에 콜백 메서드 할당

리본 XML 파일의 컨트롤에 콜백 메서드를 할당하려면 콜백 메서드의 형식 및 메서드 이름을 지정하는 특성을 추가합니다. 예를 들어 다음 요소는 OnToggleButton1 이라는 OnToggleButton1을 참조하세요.

<toggleButton id="toggleButton1" onAction="OnToggleButton1" />

onAction 은 사용자가 특정 컨트롤에 연결된 기본 작업을 수행할 때 호출됩니다. 예를 들어 토글 단추의 onAction 콜백 메서드는 사용자가 단추를 클릭할 때 호출됩니다.

특성에 지정하는 메서드는 아무 이름이나 사용할 수 있습니다. 그러나 리본 코드 파일에서 정의하는 메서드 이름과 일치해야 합니다.

리본 컨트롤에 할당할 수 있는 다양한 형식의 콜백 메서드가 있습니다. 각 컨트롤에 대해 사용할 수 있는 콜백 메서드의 전체 목록은 기술 문서 개발자용 Office(2007) 리본 사용자 인터페이스 사용자 지정(3/3부)를 참조하세요.

콜백 메서드 정의

리본 코드 파일의 리본 클래스에서 콜백 메서드를 정의합니다. 콜백 메서드에는 다음과 같은 여러 요구 사항이 있습니다.

public으로 선언해야 합니다.
해당 이름은 리본 XML 파일에서 컨트롤에 할당한 콜백 메서드의 이름과 일치해야 합니다.
해당 서명은 연결된 리본 컨트롤에 사용할 수 있는 콜백 메서드의 형식 서명과 일치해야 합니다.

리본 컨트롤에 대한 콜백 메서드 서명의 전체 목록은 기술 문서 개발자용 Office(2007) 리본 사용자 인터페이스 사용자 지정(3/3부)를 참조하세요. Visual Studio는 리본 코드 파일에서 만든 콜백 메서드에 대해 IntelliSense 지원을 제공하지 않습니다. 유효한 서명과 일치하지 않는 콜백 메서드를 만드는 경우 코드가 컴파일되지만 사용자가 컨트롤을 클릭할 때 아무 작업도 수행되지 않습니다.

모든 콜백 메서드에 메서드를 호출한 컨트롤을 나타내는 IRibbonControl 매개 변수가 있습니다. 이 매개 변수를 사용하여 여러 컨트롤에 대해 동일한 콜백 메서드를 다시 사용할 수 있습니다. 다음 코드 예제에서는 사용자가 클릭하는 컨트롤에 따라 다른 작업을 수행하는 onAction 콜백 메서드를 보여 줍니다.
- C#
- VB
```
public void OnActionCallback(Office.IRibbonControl control, bool isPressed)
{
    if (control.Id == "checkBox1")
    {
        MessageBox.Show("You clicked " + control.Id);
    }
    else
    {
        MessageBox.Show("You clicked a different control.");
    }
}
```
```
Public Sub OnActionCallback(ByVal control As Office.IRibbonControl, _
    ByVal isPressed As Boolean)

    If (control.Id = "checkBox1") Then
        MessageBox.Show("You clicked " + control.Id)
    Else
        MessageBox.Show("You clicked a different control.")
    End If

End Sub
```

리본 XML 파일 참조

리본 XML 파일에 요소 및 특성을 추가하여 사용자 지정 리본을 정의할 수 있습니다. 기본적으로 리본 XML 파일에는 다음 XML이 포함되어 있습니다.

<?xml version="1.0" encoding="UTF-8"?>
<customUI xmlns="http://schemas.microsoft.com/office/2006/01/customui" onLoad="OnLoad">
  <ribbon>
    <tabs>
      <tab idMso="TabAddIns">
        <group id="MyGroup"
               label="My Group">
        </group>
      </tab>
    </tabs>
  </ribbon>
</customUI>

다음 표에서는 리본 XML 파일의 기본 요소를 설명합니다.

요소	설명
customUI	VSTO 추가 기능 프로젝트의 사용자 지정 리본을 나타냅니다.
T:Microsoft.Office.Core.IRibbonControl	리본을 나타냅니다.
탭	리본 탭 집합을 나타냅니다.
탭	리본 탭 하나를 나타냅니다.
group	리본 탭의 컨트롤 그룹을 나타냅니다.

이러한 요소에는 사용자 지정 리본의 모양 및 동작을 지정하는 특성이 있습니다. 다음 표에서는 리본 XML 파일의 기본 특성을 설명합니다.

Attribute	상위 요소	설명
onLoad	customUI	애플리케이션에서 리본을 로드할 때 호출되는 메서드를 식별합니다.
idMso	탭	리본에 표시할 기본 제공 탭을 식별합니다.
id	group	그룹을 식별합니다.
label	group	그룹에 나타나는 텍스트를 지정합니다.

리본 XML 파일의 기본 요소와 특성은 사용할 수 있는 요소 및 특성의 일부에 불과합니다. 사용 가능한 요소 및 특성의 전체 목록은 기술 문서 개발자용 Office(2007) 리본 사용자 인터페이스 사용자 지정(2/3부)를 참조하세요.

리본 클래스 참조

Visual Studio는 리본 코드 파일에 리본 클래스를 생성합니다. 이 클래스에 리본의 컨트롤에 대한 콜백 메서드를 추가합니다. 이 클래스는 IRibbonExtensibility 인터페이스를 구현합니다.

다음 표에서는 이 클래스의 기본 메서드를 설명합니다.

메서드	설명
`GetCustomUI`	리본 XML 파일의 내용을 반환합니다. Microsoft Office 애플리케이션은 이 메서드를 호출하여 사용자 지정 리본의 사용자 인터페이스를 정의하는 XML 문자열을 가져옵니다. 이 메서드는 GetCustomUI 메서드를 구현합니다. 참고:`GetCustomUI`는 리본 XML 파일의 내용만 반환하도록 구현해야 합니다. VSTO 추가 기능을 초기화하는 데 사용하면 안 됩니다. 특히, `GetCustomUI` 구현에서 대화 상자 또는 다른 창을 표시하려고 하면 안 됩니다. 그렇지 않으면 사용자 지정 리본이 올바르게 동작하지 않을 수 있습니다. VSTO 추가 기능을 초기화하는 코드를 실행해야 하는 경우 `ThisAddIn_Startup` 이벤트 처리기에 코드를 추가합니다.
`OnLoad`	IRibbonControl 필드에 `Ribbon` 매개 변수를 할당합니다. 사용자 지정 리본을 로드하는 경우 Microsoft Office 애플리케이션에서 이 메서드를 호출합니다. 이 필드를 사용하여 사용자 지정 리본을 동적으로 업데이트할 수 있습니다. 자세한 내용은 기술 문서 개발자용 Office(2007) 리본 사용자 인터페이스 사용자 지정(1/3부)를 참조하세요.
`GetResourceText`	`GetCustomUI` 메서드에서 리본 XML 파일의 내용을 가져오기 위해 호출합니다.