main
1<?xml version="1.0"?>
2<doc>
3 <assembly>
4 <name>CommandLine</name>
5 </assembly>
6 <members>
7 <member name="T:CommandLine.Text.HelpText">
8 <summary>
9 Models an help text and collects related informations.
10 You can assign it in place of a <see cref="T:System.String"/> instance, this is why
11 this type lacks a method to add lines after the options usage informations;
12 simple use a <see cref="T:System.Text.StringBuilder"/> or similar solutions.
13 </summary>
14 </member>
15 <member name="M:CommandLine.Text.HelpText.#ctor(System.String)">
16 <summary>
17 Initializes a new instance of the <see cref="T:CommandLine.Text.HelpText"/> class
18 specifying heading informations.
19 </summary>
20 <param name="heading">A string with heading information or
21 an instance of <see cref="T:CommandLine.Text.HeadingInfo"/>.</param>
22 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="heading"/> is null or empty string.</exception>
23 </member>
24 <member name="M:CommandLine.Text.HelpText.AddPreOptionsLine(System.String)">
25 <summary>
26 Adds a text line after copyright and before options usage informations.
27 </summary>
28 <param name="value">A <see cref="T:System.String"/> instance.</param>
29 <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="value"/> is null or empty string.</exception>
30 </member>
31 <member name="M:CommandLine.Text.HelpText.AddOptions(System.Object)">
32 <summary>
33 Adds a text block with options usage informations.
34 </summary>
35 <param name="options">The instance that collected command line arguments parsed with <see cref="T:CommandLine.Parser"/> class.</param>
36 <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="options"/> is null.</exception>
37 </member>
38 <member name="M:CommandLine.Text.HelpText.AddOptions(System.Object,System.String)">
39 <summary>
40 Adds a text block with options usage informations.
41 </summary>
42 <param name="options">The instance that collected command line arguments parsed with the <see cref="T:CommandLine.Parser"/> class.</param>
43 <param name="requiredWord">The word to use when the option is required.</param>
44 <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="options"/> is null.</exception>
45 <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="requiredWord"/> is null or empty string.</exception>
46 </member>
47 <member name="M:CommandLine.Text.HelpText.ToString">
48 <summary>
49 Returns the help informations as a <see cref="T:System.String"/>.
50 </summary>
51 <returns>The <see cref="T:System.String"/> that contains the help informations.</returns>
52 </member>
53 <member name="M:CommandLine.Text.HelpText.op_Implicit(CommandLine.Text.HelpText)~System.String">
54 <summary>
55 Converts the help informations to a <see cref="T:System.String"/>.
56 </summary>
57 <param name="info">This <see cref="T:CommandLine.Text.HelpText"/> instance.</param>
58 <returns>The <see cref="T:System.String"/> that contains the help informations.</returns>
59 </member>
60 <member name="P:CommandLine.Text.HelpText.Copyright">
61 <summary>
62 Sets the copyright information string.
63 You can directly assign a <see cref="T:CommandLine.Text.CopyrightInfo"/> instance.
64 </summary>
65 </member>
66 <member name="T:CommandLine.OptionAttribute">
67 <summary>
68 Models an option specification.
69 </summary>
70 </member>
71 <member name="T:CommandLine.BaseOptionAttribute">
72 <summary>
73 Provides base properties for creating an attribute, used to define rules for command line parsing.
74 </summary>
75 </member>
76 <member name="P:CommandLine.BaseOptionAttribute.ShortName">
77 <summary>
78 Short name of this command line option. This name is usually a single character.
79 </summary>
80 </member>
81 <member name="P:CommandLine.BaseOptionAttribute.LongName">
82 <summary>
83 Long name of this command line option. This name is usually a single english word.
84 </summary>
85 </member>
86 <member name="P:CommandLine.BaseOptionAttribute.Required">
87 <summary>
88 True if this command line option is required.
89 </summary>
90 </member>
91 <member name="P:CommandLine.BaseOptionAttribute.HelpText">
92 <summary>
93 A short description of this command line option. Usually a sentence summary.
94 </summary>
95 </member>
96 <member name="M:CommandLine.OptionAttribute.#ctor(System.String,System.String)">
97 <summary>
98 Initializes a new instance of the <see cref="T:CommandLine.OptionAttribute"/> class.
99 </summary>
100 <param name="shortName">The short name of the option or null if not used.</param>
101 <param name="longName">The long name of the option or null if not used.</param>
102 </member>
103 <member name="T:CommandLine.Text.CopyrightInfo">
104 <summary>
105 Models the copyright informations part of an help text.
106 You can assign it where you assign any <see cref="T:System.String"/> instance.
107 </summary>
108 </member>
109 <member name="M:CommandLine.Text.CopyrightInfo.#ctor">
110 <summary>
111 Initializes a new instance of the <see cref="T:CommandLine.Text.CopyrightInfo"/> class.
112 </summary>
113 </member>
114 <member name="M:CommandLine.Text.CopyrightInfo.#ctor(System.String,System.Int32)">
115 <summary>
116 Initializes a new instance of the <see cref="T:CommandLine.Text.CopyrightInfo"/> class
117 specifying author and year.
118 </summary>
119 <param name="author">The company or person holding the copyright.</param>
120 <param name="year">The year of coverage of copyright.</param>
121 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="author"/> is null or empty string.</exception>
122 </member>
123 <member name="M:CommandLine.Text.CopyrightInfo.#ctor(System.String,System.Int32[])">
124 <summary>
125 Initializes a new instance of the <see cref="T:CommandLine.Text.CopyrightInfo"/> class
126 specifying author and years.
127 </summary>
128 <param name="author">The company or person holding the copyright.</param>
129 <param name="years">The years of coverage of copyright.</param>
130 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="author"/> is null or empty string.</exception>
131 <exception cref="T:System.ArgumentOutOfRangeException">Thrown when parameter <paramref name="years"/> is not supplied.</exception>
132 </member>
133 <member name="M:CommandLine.Text.CopyrightInfo.#ctor(System.Boolean,System.String,System.Int32[])">
134 <summary>
135 Initializes a new instance of the <see cref="T:CommandLine.Text.CopyrightInfo"/> class
136 specifying symbol case, author and years.
137 </summary>
138 <param name="isSymbolUpper">The case of the copyright symbol.</param>
139 <param name="author">The company or person holding the copyright.</param>
140 <param name="years">The years of coverage of copyright.</param>
141 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="author"/> is null or empty string.</exception>
142 <exception cref="T:System.ArgumentOutOfRangeException">Thrown when parameter <paramref name="years"/> is not supplied.</exception>
143 </member>
144 <member name="M:CommandLine.Text.CopyrightInfo.ToString">
145 <summary>
146 Returns the copyright informations as a <see cref="T:System.String"/>.
147 </summary>
148 <returns>The <see cref="T:System.String"/> that contains the copyright informations.</returns>
149 </member>
150 <member name="M:CommandLine.Text.CopyrightInfo.op_Implicit(CommandLine.Text.CopyrightInfo)~System.String">
151 <summary>
152 Converts the copyright informations to a <see cref="T:System.String"/>.
153 </summary>
154 <param name="info">This <see cref="T:CommandLine.Text.CopyrightInfo"/> instance.</param>
155 <returns>The <see cref="T:System.String"/> that contains the copyright informations.</returns>
156 </member>
157 <member name="M:CommandLine.Text.CopyrightInfo.FormatYears(System.Int32[])">
158 <summary>
159 When overridden in a derived class, allows to specify a new algorithm to render copyright years
160 as a <see cref="T:System.String"/> instance.
161 </summary>
162 <param name="years">A <see cref="T:System.Int32"/> array of years.</param>
163 <returns>A <see cref="T:System.String"/> instance with copyright years.</returns>
164 </member>
165 <member name="P:CommandLine.Text.CopyrightInfo.CopyrightWord">
166 <summary>
167 When overridden in a derived class, allows to specify a different copyright word.
168 </summary>
169 </member>
170 <member name="T:CommandLine.HelpOptionAttribute">
171 <summary>
172 Indicates the instance method that must be invoked when it becomes necessary show your help screen.
173 The method signature is an instance method with no parameters and <see cref="T:System.String"/>
174 return value.
175 </summary>
176 </member>
177 <member name="M:CommandLine.HelpOptionAttribute.#ctor">
178 <summary>
179 Initializes a new instance of the <see cref="T:CommandLine.HelpOptionAttribute"/> class.
180 </summary>
181 </member>
182 <member name="M:CommandLine.HelpOptionAttribute.#ctor(System.String,System.String)">
183 <summary>
184 Initializes a new instance of the <see cref="T:CommandLine.HelpOptionAttribute"/> class.
185 Allows you to define short and long option names.
186 </summary>
187 <param name="shortName">The short name of the option or null if not used.</param>
188 <param name="longName">The long name of the option or null if not used.</param>
189 </member>
190 <member name="P:CommandLine.HelpOptionAttribute.Required">
191 <summary>
192 Returns always false for this kind of option.
193 This behaviour can't be changed by design; if you try set <see cref="P:CommandLine.HelpOptionAttribute.Required"/>
194 an <see cref="T:System.InvalidOperationException"/> will be thrown.
195 </summary>
196 </member>
197 <member name="T:CommandLine.OptionListAttribute">
198 <summary>
199 Models an option that can accept multiple values.
200 Must be applied to a field compatible with an <see cref="T:System.Collections.Generic.IList`1"/> interface
201 of <see cref="T:System.String"/> instances.
202 </summary>
203 </member>
204 <member name="M:CommandLine.OptionListAttribute.#ctor(System.String,System.String)">
205 <summary>
206 Initializes a new instance of the <see cref="T:CommandLine.OptionListAttribute"/> class.
207 </summary>
208 <param name="shortName">The short name of the option or null if not used.</param>
209 <param name="longName">The long name of the option or null if not used.</param>
210 </member>
211 <member name="M:CommandLine.OptionListAttribute.#ctor(System.String,System.String,System.Char)">
212 <summary>
213 Initializes a new instance of the <see cref="T:CommandLine.OptionListAttribute"/> class.
214 </summary>
215 <param name="shortName">The short name of the option or null if not used.</param>
216 <param name="longName">The long name of the option or null if not used.</param>
217 <param name="separator">Values separator character.</param>
218 </member>
219 <member name="P:CommandLine.OptionListAttribute.Separator">
220 <summary>
221 Gets or sets the values separator character.
222 </summary>
223 </member>
224 <member name="T:CommandLine.ValueListAttribute">
225 <summary>
226 Models a list of command line arguments that are not options.
227 Must be applied to a field compatible with an <see cref="T:System.Collections.Generic.IList`1"/> interface
228 of <see cref="T:System.String"/> instances.
229 </summary>
230 </member>
231 <member name="M:CommandLine.ValueListAttribute.#ctor(System.Type)">
232 <summary>
233 Initializes a new instance of the <see cref="T:CommandLine.ValueListAttribute"/> class.
234 </summary>
235 <param name="concreteType">A type that implements <see cref="T:System.Collections.Generic.IList`1"/>.</param>
236 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="concreteType"/> is null.</exception>
237 </member>
238 <member name="P:CommandLine.ValueListAttribute.MaximumElements">
239 <summary>
240 Gets or sets the maximum element allow for the list managed by <see cref="T:CommandLine.ValueListAttribute"/> type.
241 If lesser than 0, no upper bound is fixed.
242 If equal to 0, no elements are allowed.
243 </summary>
244 </member>
245 <member name="T:CommandLine.Parser">
246 <summary>
247 Provides methods to parse command line arguments. This class cannot be inherited.
248 </summary>
249 </member>
250 <member name="M:CommandLine.Parser.ParseArguments(System.String[],System.Object)">
251 <summary>
252 Parses a <see cref="T:System.String"/> array of command line arguments,
253 setting values read in <paramref name="options"/> parameter instance.
254 </summary>
255 <param name="args">A <see cref="T:System.String"/> array of command line arguments.</param>
256 <param name="options">An instance to receive values.
257 Parsing rules are defined using <see cref="T:CommandLine.BaseOptionAttribute"/> derived types.</param>
258 <returns>True if parsing process succeed.</returns>
259 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="args"/> is null.</exception>
260 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options"/> is null.</exception>
261 </member>
262 <member name="M:CommandLine.Parser.ParseArguments(System.String[],System.Object,System.IO.TextWriter)">
263 <summary>
264 Parses a <see cref="T:System.String"/> array of command line arguments,
265 setting values read in <paramref name="options"/> parameter instance.
266 This overloads allows you to specify a <see cref="T:System.IO.TextWriter"/>
267 derived instance for write text messages.
268 </summary>
269 <param name="args">A <see cref="T:System.String"/> array of command line arguments.</param>
270 <param name="options">An instance to receive values.
271 Parsing rules are defined using <see cref="T:CommandLine.BaseOptionAttribute"/> derived types.</param>
272 <param name="helpWriter">Any instance derived from <see cref="T:System.IO.TextWriter"/>,
273 usually <see cref="P:System.Console.Out"/>.</param>
274 <returns>True if parsing process succeed.</returns>
275 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="args"/> is null.</exception>
276 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="options"/> is null.</exception>
277 <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="helpWriter"/> is null.</exception>
278 </member>
279 <member name="T:CommandLine.IncompatibleTypesException">
280 <summary>
281 Represents the exception that is thrown when an attempt to assign incopatible types.
282 </summary>
283 </member>
284 <member name="T:CommandLine.Text.HeadingInfo">
285 <summary>
286 Models the heading informations part of an help text.
287 You can assign it where you assign any <see cref="T:System.String"/> instance.
288 </summary>
289 </member>
290 <member name="M:CommandLine.Text.HeadingInfo.#ctor(System.String)">
291 <summary>
292 Initializes a new instance of the <see cref="T:CommandLine.Text.HeadingInfo"/> class
293 specifying program name.
294 </summary>
295 <param name="programName">The name of the program.</param>
296 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="programName"/> is null or empty string.</exception>
297 </member>
298 <member name="M:CommandLine.Text.HeadingInfo.#ctor(System.String,System.String)">
299 <summary>
300 Initializes a new instance of the <see cref="T:CommandLine.Text.HeadingInfo"/> class
301 specifying program name and version.
302 </summary>
303 <param name="programName">The name of the program.</param>
304 <param name="version">The version of the program.</param>
305 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="programName"/> is null or empty string.</exception>
306 </member>
307 <member name="M:CommandLine.Text.HeadingInfo.ToString">
308 <summary>
309 Returns the heading informations as a <see cref="T:System.String"/>.
310 </summary>
311 <returns>The <see cref="T:System.String"/> that contains the heading informations.</returns>
312 </member>
313 <member name="M:CommandLine.Text.HeadingInfo.op_Implicit(CommandLine.Text.HeadingInfo)~System.String">
314 <summary>
315 Converts the heading informations to a <see cref="T:System.String"/>.
316 </summary>
317 <param name="info">This <see cref="T:CommandLine.Text.HeadingInfo"/> instance.</param>
318 <returns>The <see cref="T:System.String"/> that contains the heading informations.</returns>
319 </member>
320 <member name="M:CommandLine.Text.HeadingInfo.WriteMessage(System.String,System.IO.TextWriter)">
321 <summary>
322 Writes out a string and a new line using the program name specified in the constructor
323 and <paramref name="message"/> parameter.
324 </summary>
325 <param name="message">The <see cref="T:System.String"/> message to write.</param>
326 <param name="writer">The target <see cref="T:System.IO.TextWriter"/> derived type.</param>
327 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="message"/> is null or empty string.</exception>
328 <exception cref="T:System.ArgumentNullException">Thrown when parameter <paramref name="writer"/> is null.</exception>
329 </member>
330 <member name="M:CommandLine.Text.HeadingInfo.WriteMessage(System.String)">
331 <summary>
332 Writes out a string and a new line using the program name specified in the constructor
333 and <paramref name="message"/> parameter to standard output stream.
334 </summary>
335 <param name="message">The <see cref="T:System.String"/> message to write.</param>
336 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="message"/> is null or empty string.</exception>
337 </member>
338 <member name="M:CommandLine.Text.HeadingInfo.WriteError(System.String)">
339 <summary>
340 Writes out a string and a new line using the program name specified in the constructor
341 and <paramref name="message"/> parameter to standard error stream.
342 </summary>
343 <param name="message">The <see cref="T:System.String"/> message to write.</param>
344 <exception cref="T:System.ArgumentException">Thrown when parameter <paramref name="message"/> is null or empty string.</exception>
345 </member>
346 </members>
347</doc>