← Back to branch summary

~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to external/mono-addins/docs/Mono.Addins/TypeExtensionPointAttribute.xml

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
Import upstream version 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
external/mono-addins/docs/Mono.Addins/TypeExtensionPointAttribute.xml
 
1
<Type Name="TypeExtensionPointAttribute" FullName="Mono.Addins.TypeExtensionPointAttribute">
 
2
  <TypeSignature Language="C#" Value="public class TypeExtensionPointAttribute : Attribute" />
 
3
  <AssemblyInfo>
 
4
    <AssemblyName>Mono.Addins</AssemblyName>
 
5
    <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
6
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
 
7
  </AssemblyInfo>
 
8
  <Base>
 
9
    <BaseTypeName>System.Attribute</BaseTypeName>
 
10
  </Base>
 
11
  <Interfaces />
 
12
  <Attributes>
 
13
    <Attribute>
 
14
      <AttributeName>System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Interface | System.AttributeTargets.All, AllowMultiple=true)</AttributeName>
 
15
    </Attribute>
 
16
  </Attributes>
 
17
  <Docs>
 
18
    <summary>Indicates that a type is the source of an extension point.</summary>
 
19
    <remarks>
 
20
      <para>
 
21
When applied to a class or interface, defines a new extension point that will accept object extensions of the specified type. For example, the following declaration:
 
22
</para>
 
23
      <example>
 
24
        <code lang="C#">
 
25
[TypeExtensionPoint ("/SimpleApp/Writers", Description="Writer classes")]
 
26
public interface IWriter
 
27
{
 
28
        string Write ();
 
29
}
 
30
  </code>
 
31
      </example>
 
32
      <para>
 
33
would be equivalent to the following manifest declaration:
 
34
</para>
 
35
      <example>
 
36
        <code lang="XML">
 
37
        &lt;ExtensionPoint path = "/SimpleApp/Writers"&gt;
 
38
                &lt;Description&gt;Writer classes&lt;/Description&gt;
 
39
                &lt;ExtensionNode objectType="IWriter" /&gt;
 
40
        &lt;/ExtensionPoint&gt;
 
41
  </code>
 
42
      </example>
 
43
    </remarks>
 
44
  </Docs>
 
45
  <Members>
 
46
    <Member MemberName=".ctor">
 
47
      <MemberSignature Language="C#" Value="public TypeExtensionPointAttribute ();" />
 
48
      <MemberType>Constructor</MemberType>
 
49
      <Parameters />
 
50
      <Docs>
 
51
        <summary>Initializes a new instance.</summary>
 
52
        <remarks />
 
53
      </Docs>
 
54
      <AssemblyInfo>
 
55
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
56
      </AssemblyInfo>
 
57
    </Member>
 
58
    <Member MemberName=".ctor">
 
59
      <MemberSignature Language="C#" Value="public TypeExtensionPointAttribute (string path);" />
 
60
      <MemberType>Constructor</MemberType>
 
61
      <Parameters>
 
62
        <Parameter Name="path" Type="System.String" />
 
63
      </Parameters>
 
64
      <Docs>
 
65
        <param name="path">Path of the extension point.</param>
 
66
        <summary>Initializes a new instance.</summary>
 
67
        <remarks />
 
68
      </Docs>
 
69
      <AssemblyInfo>
 
70
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
71
      </AssemblyInfo>
 
72
    </Member>
 
73
    <Member MemberName="Description">
 
74
      <MemberSignature Language="C#" Value="public string Description { set; get; }" />
 
75
      <MemberType>Property</MemberType>
 
76
      <ReturnValue>
 
77
        <ReturnType>System.String</ReturnType>
 
78
      </ReturnValue>
 
79
      <Docs>
 
80
        <summary>Description of the extension point.</summary>
 
81
        <value>Description of the extension point.</value>
 
82
        <remarks>To be used in the extension point documentation.</remarks>
 
83
      </Docs>
 
84
      <AssemblyInfo>
 
85
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
86
      </AssemblyInfo>
 
87
    </Member>
 
88
    <Member MemberName="Name">
 
89
      <MemberSignature Language="C#" Value="public string Name { set; get; }" />
 
90
      <MemberType>Property</MemberType>
 
91
      <ReturnValue>
 
92
        <ReturnType>System.String</ReturnType>
 
93
      </ReturnValue>
 
94
      <Docs>
 
95
        <summary>Display name of the extension point.</summary>
 
96
        <value>Display name of the extension point.</value>
 
97
        <remarks>This name is for documentation pourposes only.</remarks>
 
98
      </Docs>
 
99
      <AssemblyInfo>
 
100
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
101
      </AssemblyInfo>
 
102
    </Member>
 
103
    <Member MemberName="NodeName">
 
104
      <MemberSignature Language="C#" Value="public string NodeName { set; get; }" />
 
105
      <MemberType>Property</MemberType>
 
106
      <ReturnValue>
 
107
        <ReturnType>System.String</ReturnType>
 
108
      </ReturnValue>
 
109
      <Docs>
 
110
        <summary>Node name to be used when registering extensions in this extension point.</summary>
 
111
        <value>Name of the node.</value>
 
112
        <remarks>Node name to be used when registering extensions in this extension point.</remarks>
 
113
      </Docs>
 
114
      <AssemblyInfo>
 
115
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
116
      </AssemblyInfo>
 
117
    </Member>
 
118
    <Member MemberName="NodeType">
 
119
      <MemberSignature Language="C#" Value="public Type NodeType { set; get; }" />
 
120
      <MemberType>Property</MemberType>
 
121
      <ReturnValue>
 
122
        <ReturnType>System.Type</ReturnType>
 
123
      </ReturnValue>
 
124
      <Docs>
 
125
        <summary>Node type allowed in this extension point.</summary>
 
126
        <value>A subclass of <see cref="T:Mono.Addins.ExtensionNode" />.</value>
 
127
        <remarks>Extension points declared using this attribute can only accept one type of extension node. To allow several types in an extension point, it has to be declared in an xml manifest.</remarks>
 
128
      </Docs>
 
129
      <AssemblyInfo>
 
130
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
131
      </AssemblyInfo>
 
132
    </Member>
 
133
    <Member MemberName="Path">
 
134
      <MemberSignature Language="C#" Value="public string Path { set; get; }" />
 
135
      <MemberType>Property</MemberType>
 
136
      <ReturnValue>
 
137
        <ReturnType>System.String</ReturnType>
 
138
      </ReturnValue>
 
139
      <Docs>
 
140
        <summary>Path of the extension point.</summary>
 
141
        <value>Path of the extension point.</value>
 
142
        <remarks>If not provided, the add-in manager will assign a default extension path.</remarks>
 
143
      </Docs>
 
144
      <AssemblyInfo>
 
145
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
146
      </AssemblyInfo>
 
147
    </Member>
 
148
  </Members>
 
149
</Type>