Repository navigation
Expand file tree
/
Copy pathCodeNamespace.xml
More file actions
278 lines (269 loc) · 14.3 KB
/
Copy pathCodeNamespace.xml
File metadata and controls
278 lines (269 loc) · 14.3 KB
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
<Type Name="CodeNamespace" FullName="System.CodeDom.CodeNamespace">
<TypeSignature Language="C#" Value="public class CodeNamespace : System.CodeDom.CodeObject" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi serializable beforefieldinit CodeNamespace extends System.CodeDom.CodeObject" />
<TypeSignature Language="DocId" Value="T:System.CodeDom.CodeNamespace" />
<TypeSignature Language="VB.NET" Value="Public Class CodeNamespace
Inherits CodeObject" />
<TypeSignature Language="C++ CLI" Value="public ref class CodeNamespace : System::CodeDom::CodeObject" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.CodeDom</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.CodeDom.CodeObject</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ClassInterface</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.ComVisible(true)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a namespace declaration.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.CodeDom.CodeNamespace> can be used to represent a namespace declaration.
The <xref:System.CodeDom.CodeNamespace.Name%2A> property specifies the name of the namespace. The <xref:System.CodeDom.CodeNamespace.Imports%2A> property contains the namespace import directives for the namespace. The <xref:System.CodeDom.CodeNamespace.Types%2A> property contains the type declarations for the namespace. The <xref:System.CodeDom.CodeNamespace.Comments%2A> property contains the comments that apply at the namespace level.
In some languages, a namespace can function as a container for type declarations; all types in the same namespace are accessible without using fully-qualified type references, if the there is no conflict between type names.
> [!NOTE]
> Use fully qualified type references to avoid potential ambiguity.
## Examples
The following example code demonstrates use of a <xref:System.CodeDom.CodeNamespace> to declare a namespace.
[!code-cpp[CodeNamespaceExample#2](~/samples/snippets/cpp/VS_Snippets_CLR/CodeNamespaceExample/CPP/codenamespaceexample.cpp#2)]
[!code-csharp[CodeNamespaceExample#2](~/samples/snippets/csharp/VS_Snippets_CLR/CodeNamespaceExample/CS/codenamespaceexample.cs#2)]
[!code-vb[CodeNamespaceExample#2](~/samples/snippets/visualbasic/VS_Snippets_CLR/CodeNamespaceExample/VB/codenamespaceexample.vb#2)]
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.CodeDom.CodeNamespace" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CodeNamespace ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.CodeDom.CodeNamespace.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 CodeNamespace();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.CodeDom</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.CodeDom.CodeNamespace" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CodeNamespace (string name);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name) cil managed" />
<MemberSignature Language="DocId" Value="M:System.CodeDom.CodeNamespace.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String)" />
<MemberSignature Language="C++ CLI" Value="public:
 CodeNamespace(System::String ^ name);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.CodeDom</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The name of the namespace being declared.</param>
<summary>Initializes a new instance of the <see cref="T:System.CodeDom.CodeNamespace" /> class using the specified name.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Comments">
<MemberSignature Language="C#" Value="public System.CodeDom.CodeCommentStatementCollection Comments { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.CodeDom.CodeCommentStatementCollection Comments" />
<MemberSignature Language="DocId" Value="P:System.CodeDom.CodeNamespace.Comments" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Comments As CodeCommentStatementCollection" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::CodeDom::CodeCommentStatementCollection ^ Comments { System::CodeDom::CodeCommentStatementCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.CodeDom</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.CodeDom.CodeCommentStatementCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the comments for the namespace.</summary>
<value>A <see cref="T:System.CodeDom.CodeCommentStatementCollection" /> that indicates the comments for the namespace.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.CodeDom.CodeCommentStatementCollection" />
</Docs>
</Member>
<Member MemberName="Imports">
<MemberSignature Language="C#" Value="public System.CodeDom.CodeNamespaceImportCollection Imports { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.CodeDom.CodeNamespaceImportCollection Imports" />
<MemberSignature Language="DocId" Value="P:System.CodeDom.CodeNamespace.Imports" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Imports As CodeNamespaceImportCollection" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::CodeDom::CodeNamespaceImportCollection ^ Imports { System::CodeDom::CodeNamespaceImportCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.CodeDom</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.CodeDom.CodeNamespaceImportCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the collection of namespace import directives used by the namespace.</summary>
<value>A <see cref="T:System.CodeDom.CodeNamespaceImportCollection" /> that indicates the namespace import directives used by the namespace.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.CodeDom.CodeNamespaceImportCollection" />
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:System.CodeDom.CodeNamespace.Name" />
<MemberSignature Language="VB.NET" Value="Public Property Name As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Name { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.CodeDom</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the name of the namespace.</summary>
<value>The name of the namespace.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PopulateComments">
<MemberSignature Language="C#" Value="public event EventHandler PopulateComments;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler PopulateComments" />
<MemberSignature Language="DocId" Value="E:System.CodeDom.CodeNamespace.PopulateComments" />
<MemberSignature Language="VB.NET" Value="Public Custom Event PopulateComments As EventHandler " />
<MemberSignature Language="C++ CLI" Value="public:
 event EventHandler ^ PopulateComments;" />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.CodeDom</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>An event that will be raised the first time the <see cref="P:System.CodeDom.CodeNamespace.Comments" /> collection is accessed.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PopulateImports">
<MemberSignature Language="C#" Value="public event EventHandler PopulateImports;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler PopulateImports" />
<MemberSignature Language="DocId" Value="E:System.CodeDom.CodeNamespace.PopulateImports" />
<MemberSignature Language="VB.NET" Value="Public Custom Event PopulateImports As EventHandler " />
<MemberSignature Language="C++ CLI" Value="public:
 event EventHandler ^ PopulateImports;" />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.CodeDom</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>An event that will be raised the first time the <see cref="P:System.CodeDom.CodeNamespace.Imports" /> collection is accessed.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PopulateTypes">
<MemberSignature Language="C#" Value="public event EventHandler PopulateTypes;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler PopulateTypes" />
<MemberSignature Language="DocId" Value="E:System.CodeDom.CodeNamespace.PopulateTypes" />
<MemberSignature Language="VB.NET" Value="Public Custom Event PopulateTypes As EventHandler " />
<MemberSignature Language="C++ CLI" Value="public:
 event EventHandler ^ PopulateTypes;" />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.CodeDom</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>An event that will be raised the first time the <see cref="P:System.CodeDom.CodeNamespace.Types" /> collection is accessed.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Types">
<MemberSignature Language="C#" Value="public System.CodeDom.CodeTypeDeclarationCollection Types { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.CodeDom.CodeTypeDeclarationCollection Types" />
<MemberSignature Language="DocId" Value="P:System.CodeDom.CodeNamespace.Types" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Types As CodeTypeDeclarationCollection" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::CodeDom::CodeTypeDeclarationCollection ^ Types { System::CodeDom::CodeTypeDeclarationCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.CodeDom</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.CodeDom.CodeTypeDeclarationCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the collection of types that the namespace contains.</summary>
<value>A <see cref="T:System.CodeDom.CodeTypeDeclarationCollection" /> that indicates the types contained in the namespace.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.CodeDom.CodeTypeDeclarationCollection" />
</Docs>
</Member>
</Members>
</Type>