-
Notifications
You must be signed in to change notification settings - Fork 13
/
IRibbonExtensibility.xml
93 lines (85 loc) · 4.8 KB
/
IRibbonExtensibility.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<Type Name="IRibbonExtensibility" FullName="Microsoft.Office.Core.IRibbonExtensibility">
<TypeSignature Language="C++ CLI" Value="public interface class IRibbonExtensibility" />
<TypeSignature Language="C#" Value="public interface IRibbonExtensibility" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IRibbonExtensibility" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.Core.IRibbonExtensibility" />
<TypeSignature Language="VB.NET" Value="Public Interface IRibbonExtensibility" />
<TypeSignature Language="F#" Value="type IRibbonExtensibility = interface" />
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.Guid("000C0396-0000-0000-C000-000000000046")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.Guid("000C0396-0000-0000-C000-000000000046")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.TypeLibType(4160)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.TypeLibType(4160)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>The interface through which the Ribbon user interface (UI) communicates with a COM add-in to customize the UI.</summary>
<remarks>
<para>The <b>IRibbonExtensibility</b> interface has a single method, <b>GetCustomUI</b>.</para>
<para />
</remarks>
<example>
<para>In the following example, written in C#, the <b>IRibbonExtensibility</b> interface is specified in the class definition. The procedure then implements the interfaces's only method, <b>GetCustomUI</b>. This method creates an instance of a <b>SteamReader</b> object that reads in the customized markup stored in an external XML file. </para>
<code>public class Connect : Object, Extensibility.IDTExtensibility2, IRibbonExtensibility
...
public string GetCustomUI(string RibbonID)
{
StreamReader customUIReader = new System.IO.StreamReader("C:\\RibbonXSampleCS\\customUI.xml");
string customUIData = customUIReader.ReadToEnd();
return customUIData;
}</code>
</example>
</Docs>
<Members>
<Member MemberName="GetCustomUI">
<MemberSignature Language="C++ CLI" Value="public:
 System::String ^ GetCustomUI(System::String ^ RibbonID);" />
<MemberSignature Language="C#" Value="public string GetCustomUI (string RibbonID);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string GetCustomUI([in]string RibbonID) runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Core.IRibbonExtensibility.GetCustomUI(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetCustomUI (RibbonID As String) As String" />
<MemberSignature Language="F#" Value="abstract member GetCustomUI : string -> string" Usage="iRibbonExtensibility.GetCustomUI RibbonID" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="RibbonID" Type="System.String" />
</Parameters>
<Docs>
<param name="RibbonID">To be added.</param>
<summary>Loads the XML markup, either from an XML customization file or from XML markup embedded in the procedure, that customizes the Ribbon user interface.</summary>
<returns>String</returns>
<remarks>To be added.</remarks>
<example>
<para>In the following example, written in C#, the <b>IRibbonExtensibility</b> interface is specified in the class definition. The example then implements the interfaces's only method, <b>GetCustomUI</b>. The method creates an instance of a <b>SteamReader</b> object that reads in the customization markup in an external XML file. </para>
<code>public class Connect : Object, Extensibility.IDTExtensibility2, IRibbonExtensibility
...
public string GetCustomUI(string RibbonID)
{
StreamReader customUIReader = new System.IO.StreamReader("C:\\RibbonXSampleCS\\customUI.xml");
string customUIData = customUIReader.ReadToEnd();
return customUIData;
}</code>
</example>
</Docs>
</Member>
</Members>
</Type>