Repository navigation
Expand file tree
/
Copy pathPSModuleDevelopment.xml
More file actions
679 lines (679 loc) · 27.1 KB
/
Copy pathPSModuleDevelopment.xml
File metadata and controls
679 lines (679 loc) · 27.1 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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
<?xml version="1.0"?>
<doc>
<assembly>
<name>PSModuleDevelopment</name>
</assembly>
<members>
<member name="T:PSModuleDevelopment.Format.Column">
<summary>
A column in a format table definition
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.Column.PropertyName">
<summary>
The name to select a property by. Ignored if a scriptblock is set.
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.Column.ScriptBlock">
<summary>
A scriptblock to determine column content at runtime
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.Column.Label">
<summary>
The label to apply to the column
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.Column.Width">
<summary>
Total width of the column. Anything less than one will be ignored.
</summary>
</member>
<member name="P:PSModuleDevelopment.Format.Column.SortableName">
<summary>
Name to show and sort with. Used for sorting and to explicitly assign positions.
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.Column.Alignment">
<summary>
How to align the text.
</summary>
</member>
<member name="P:PSModuleDevelopment.Format.Column.TextHeader">
<summary>
The text to use in the definition's header
</summary>
</member>
<member name="P:PSModuleDevelopment.Format.Column.TextBody">
<summary>
The text to use in the definition's body
</summary>
</member>
<member name="M:PSModuleDevelopment.Format.Column.CompareTo(System.Object)">
<summary>
Compares one column with another
</summary>
<param name="Item">The item to compare the current one with</param>
<returns>-1, 0 or 1</returns>
</member>
<member name="T:PSModuleDevelopment.Format.Alignment">
<summary>
The way text can be oriented
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.Alignment.None">
<summary>
No alignment implies the property being not set. Instead, it will use the datatype default orientation.
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.Alignment.Left">
<summary>
Text is oriented to the left
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.Alignment.Center">
<summary>
Text is centered
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.Alignment.Right">
<summary>
Text is oriented to the right
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.Alignment.Undefined">
<summary>
There was no alignment specified. Used to not apply changes during transformation
</summary>
</member>
<member name="T:PSModuleDevelopment.Format.ColumnTransformation">
<summary>
A set of transformation rules that determine, wheter a column needs to be updated
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.ColumnTransformation.FilterViewName">
<summary>
A filter rule, based on the name of the view
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.ColumnTransformation.FilterColumnName">
<summary>
A filter rule, based on the name of the column
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.ColumnTransformation.Append">
<summary>
Whether the rule should be added as an additional property, if no matching ColumName was found.
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.ColumnTransformation.ScriptBlock">
<summary>
A scriptblock to determine column content at runtime
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.ColumnTransformation.Label">
<summary>
The label to apply to the column
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.ColumnTransformation.Width">
<summary>
Total width of the column. Anything less than one will be ignored.
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.ColumnTransformation.Alignment">
<summary>
How to align the text.
</summary>
</member>
<member name="M:PSModuleDevelopment.Format.ColumnTransformation.#ctor">
<summary>
Empty constructor for manual assembly
</summary>
</member>
<member name="M:PSModuleDevelopment.Format.ColumnTransformation.#ctor(System.Collections.Hashtable)">
<summary>
Hashtable constructor, in order to automatically convert&understand input
</summary>
<param name="Table">The hashtable to parse</param>
</member>
<member name="M:PSModuleDevelopment.Format.ColumnTransformation.Apply(PSModuleDevelopment.Format.Column)">
<summary>
Applies changes to column
</summary>
<param name="Item">The column to affect</param>
</member>
<member name="T:PSModuleDevelopment.Format.Document">
<summary>
A format document. Should be written to a *.Format.ps1xml format.
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.Document.Name">
<summary>
Name of the document. Purely cosmetic in nature.
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.Document.Views">
<summary>
List of views stored in this document.
</summary>
</member>
<member name="P:PSModuleDevelopment.Format.Document.Text">
<summary>
The XML definition of this format document
</summary>
</member>
<member name="M:PSModuleDevelopment.Format.Document.ToString">
<summary>
Returns the string representation of the format XML
</summary>
<returns>The string representation of the format XML</returns>
</member>
<member name="T:PSModuleDevelopment.Format.TableDefinition">
<summary>
A Format Table definition
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.TableDefinition.Autosize">
<summary>
Whether to automatically size the column width
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.TableDefinition.Columns">
<summary>
List of columns to
</summary>
</member>
<member name="P:PSModuleDevelopment.Format.TableDefinition.TextDefinition">
<summary>
The string representation of a format table fragment.
</summary>
</member>
<member name="M:PSModuleDevelopment.Format.TableDefinition.SetColumnOrder(System.String[])">
<summary>
Sets the columns to this specified order, using the SortableName property to assign.
Not listed properties will be moved to the end of the list.
</summary>
<param name="Names">The names to sort by</param>
</member>
<member name="M:PSModuleDevelopment.Format.TableDefinition.TransformColumn(PSModuleDevelopment.Format.ColumnTransformation)">
<summary>
Applies a transformation rule to the columns stored in this view
</summary>
<param name="Transform">The transformation rule to apply</param>
</member>
<member name="M:PSModuleDevelopment.Format.TableDefinition.ToString">
<summary>
The default string representation of a tableview format definition
</summary>
<returns>The default string representation of a tableview format definition</returns>
</member>
<member name="T:PSModuleDevelopment.Format.ViewDefinitionBase">
<summary>
Base class for format definitions
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.ViewDefinitionBase.Name">
<summary>
The name of the definition
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.ViewDefinitionBase.ViewSelectedByType">
<summary>
The typenames selected by
</summary>
</member>
<member name="F:PSModuleDevelopment.Format.ViewDefinitionBase.ViewSelectedBySet">
<summary>
The selectionset to select by
</summary>
</member>
<member name="P:PSModuleDevelopment.Format.ViewDefinitionBase.TextDefinition">
<summary>
The string representation. Must be overridden by all implementing classes.
</summary>
</member>
<member name="M:PSModuleDevelopment.Format.ViewDefinitionBase.ToString">
<summary>
The string representation. Must be overridden by all implementing classes.
</summary>
<returns>The format string to produce for the format file.</returns>
</member>
<member name="T:PSModuleDevelopment.PsmdAssembly.Constructor">
<summary>
Class containing information about a class's constructor
</summary>
</member>
<member name="P:PSModuleDevelopment.PsmdAssembly.Constructor.Type">
<summary>
The type the constructor is part of
</summary>
</member>
<member name="P:PSModuleDevelopment.PsmdAssembly.Constructor.Definition">
<summary>
The constructor definition
</summary>
</member>
<member name="P:PSModuleDevelopment.PsmdAssembly.Constructor.Public">
<summary>
Whether the constructor is public
</summary>
</member>
<member name="P:PSModuleDevelopment.PsmdAssembly.Constructor.Parameters">
<summary>
The actual parameters of the constructor
</summary>
</member>
<member name="P:PSModuleDevelopment.PsmdAssembly.Constructor.ConstructorItem">
<summary>
The actual constructor object
</summary>
</member>
<member name="M:PSModuleDevelopment.PsmdAssembly.Constructor.#ctor(System.Reflection.ConstructorInfo)">
<summary>
Creates a new constructor object, designed for display in PowerShell
</summary>
<param name="Info">The constructor info object describing the constructor</param>
</member>
<member name="T:PSModuleDevelopment.Template.ParameterScript">
<summary>
A script used to calculate content to be inserted
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.ParameterScript.Name">
<summary>
Name of the scriptblock (auto-assigned or specified)
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.ParameterScript.ScriptBlock">
<summary>
The scriptblock to invoke
</summary>
</member>
<member name="P:PSModuleDevelopment.Template.ParameterScript.StringScript">
<summary>
Direct string representation of the scriptblock.
</summary>
</member>
<member name="M:PSModuleDevelopment.Template.ParameterScript.#ctor">
<summary>
Creates an empty parameter script. Usually used in serialization.
</summary>
</member>
<member name="M:PSModuleDevelopment.Template.ParameterScript.#ctor(System.String,System.Management.Automation.ScriptBlock)">
<summary>
Creates a prefilled paramter script. Usually used when creating templates
</summary>
<param name="Name">The name of the parameter. This is used to insert it into individual files or file names.</param>
<param name="ScriptBlock"></param>
</member>
<member name="T:PSModuleDevelopment.Template.Store">
<summary>
Class containing information relating to where templates are stored
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.Store.Name">
<summary>
The name of the store
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.Store.Path">
<summary>
The path the store is pointed to
</summary>
</member>
<member name="P:PSModuleDevelopment.Template.Store.Directory">
<summary>
A directory information wrapper to more easily manipulate it
</summary>
</member>
<member name="P:PSModuleDevelopment.Template.Store.Exists">
<summary>
Whether the diretory already exists
</summary>
</member>
<member name="M:PSModuleDevelopment.Template.Store.Ensure">
<summary>
Ensures the store actually exists
</summary>
<returns>True if it worked, false otherwise</returns>
</member>
<member name="T:PSModuleDevelopment.Template.Template">
<summary>
The master class containing a template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.Template.Name">
<summary>
The name of the template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.Template.Type">
<summary>
What kind of template is this?
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.Template.Version">
<summary>
What version is the template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.Template.Description">
<summary>
Text describing the template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.Template.Author">
<summary>
Author of the template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.Template.CreatedOn">
<summary>
When was the template originally created?
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.Template.Tags">
<summary>
List of tags that have been assigned to the template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.Template.Parameters">
<summary>
List of parameters the template accepts
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.Template.Scripts">
<summary>
List of scripts that will be invoked on initialization
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.Template.Children">
<summary>
Items in the root directory of the template (which may contain children themselves).
</summary>
</member>
<member name="M:PSModuleDevelopment.Template.Template.ToTemplateInfo">
<summary>
Returns the template digest used as index file.
</summary>
<returns>A TemplateInfo object describing this template.</returns>
</member>
<member name="T:PSModuleDevelopment.Template.TemplateInfo">
<summary>
Class containing meta information about a template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateInfo.Name">
<summary>
The name of the template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateInfo.Type">
<summary>
What kind of template is this?
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateInfo.Version">
<summary>
What version is the template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateInfo.Description">
<summary>
Text describing the template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateInfo.Author">
<summary>
Author of the template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateInfo.CreatedOn">
<summary>
When was the template originally created?
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateInfo.Tags">
<summary>
List of tags that have been assigned to the template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateInfo.Parameters">
<summary>
List of parameters the template accepts
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateInfo.Store">
<summary>
The store the template is stored in.
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateInfo.Path">
<summary>
The path to the template file
</summary>
</member>
<member name="M:PSModuleDevelopment.Template.TemplateInfo.ToString">
<summary>
The version-qualified name of the template
</summary>
<returns>The version-qualified name of the template</returns>
</member>
<member name="T:PSModuleDevelopment.Template.TemplateItemBase">
<summary>
Base class for all files & folders that can be part of a template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateItemBase.Name">
<summary>
Name of the item
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateItemBase.RelativePath">
<summary>
The full path from the project root
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateItemBase.Identifier">
<summary>
The string sequence used to identify variables in this file
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateItemBase.FileSystemParameterFlat">
<summary>
List of flat string insertion parameters for the filesystem object's name
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateItemBase.FileSystemParameterScript">
<summary>
List of script value insertion parameters for the filesystem object's name
</summary>
</member>
<member name="T:PSModuleDevelopment.Template.TemplateItemFile">
<summary>
Describes a file that is part of a template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateItemFile.Value">
<summary>
The value of the file. May contain plaintext UTF8 in cases of script files or similar text files. Base64 Encoded string in case of binary files.
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateItemFile.PlainText">
<summary>
Whether the file is interpreted as plain text. If not, it will be assumed to be a Base64 encoded binary file.
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateItemFile.ContentParameterFlat">
<summary>
List of flat string insertion parameters for the plaintext file
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateItemFile.ContentParameterScript">
<summary>
List of script value insertion parameters for the plaintext file
</summary>
</member>
<member name="T:PSModuleDevelopment.Template.TemplateItemFolder">
<summary>
Describes a folder that is part of a template
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateItemFolder.Children">
<summary>
Items under the current item.
</summary>
</member>
<member name="T:PSModuleDevelopment.Template.TemplateType">
<summary>
Is the template a single file or a project?
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateType.File">
<summary>
The template consists of a single file
</summary>
</member>
<member name="F:PSModuleDevelopment.Template.TemplateType.Project">
<summary>
The template consists of multiple files
</summary>
</member>
<member name="T:PSModuleDevelopment.Utility.TextAlignment">
<summary>
What a text can be aligned to
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextAlignment.Left">
<summary>
The text should be left-aligned
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextAlignment.Center">
<summary>
The text should be centered
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextAlignment.Right">
<summary>
The text should be right aligned
</summary>
</member>
<member name="T:PSModuleDevelopment.Utility.TextHeader">
<summary>
Object containing information
</summary>
</member>
<member name="P:PSModuleDevelopment.Utility.TextHeader.Text">
<summary>
The text of the header
</summary>
</member>
<member name="P:PSModuleDevelopment.Utility.TextHeader.LinesOfText">
<summary>
The number of lines the header text has
</summary>
</member>
<member name="P:PSModuleDevelopment.Utility.TextHeader.WidthOfText">
<summary>
The maximum width any line of text has.
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextHeader.CornerLT">
<summary>
The symbol of the left top corner
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextHeader.CornerRT">
<summary>
The symbol of the right top corner
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextHeader.CornerLB">
<summary>
The symbol of the left bottom corner
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextHeader.CornerRB">
<summary>
The symbol of the right bottom corner
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextHeader.BorderRight">
<summary>
The symbol of the right border
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextHeader.BorderLeft">
<summary>
The symbol of the left border
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextHeader.BorderTop">
<summary>
The symbol of the top border
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextHeader.BorderBottom">
<summary>
The symbol of the bottom border
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextHeader.MaxWidth">
<summary>
Whether the header should be as wide as the window running the code
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextHeader.Width">
<summary>
How wide should the header be, if it isn't set to max. Anything shorter than the text width will be ignored
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextHeader.TextAlignment">
<summary>
How the text should be aligned within the header
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.TextHeader.Padding">
<summary>
Whether the text should be padded on the side it is aligned to
</summary>
</member>
<member name="M:PSModuleDevelopment.Utility.TextHeader.#ctor(System.String)">
<summary>
Creates a new header around the specified string
</summary>
<param name="Text">The string to put in a header</param>
</member>
<member name="M:PSModuleDevelopment.Utility.TextHeader.ToString">
<summary>
Converts the header into its string representation
</summary>
<returns>The header text to use whereever said header is needed.</returns>
</member>
<member name="T:PSModuleDevelopment.Utility.UtilityHost">
<summary>
Host class, containing statics in support of the utility namespace
</summary>
</member>
<member name="F:PSModuleDevelopment.Utility.UtilityHost.RawUI">
<summary>
Gives access to the host UI, in order to access window information
</summary>
</member>
<member name="M:PSModuleDevelopment.Utility.UtilityHost.IsLike(System.String,System.String,System.Boolean)">
<summary>
Implement's VB's Like operator logic.
</summary>
</member>
<member name="M:PSModuleDevelopment.Utility.UtilityHost.CharListToSet(System.String)">
<summary>
Converts a string of characters to a HashSet of characters. If the string
contains character ranges, such as A-Z, all characters in the range are
also added to the returned set of characters.
</summary>
<param name="charList">Character list string</param>
</member>
</members>
</doc>