Skip to content
This repository was archived by the owner on Apr 12, 2022. It is now read-only.

Commit ff8b677

Browse files
Update docs
1 parent 82547ab commit ff8b677

31 files changed

+1993
-160
lines changed

Docs/Add-WordHyperLink.md

Lines changed: 462 additions & 6 deletions
Large diffs are not rendered by default.

Docs/Add-WordTable.md

Lines changed: 45 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ schema: 2.0.0
1515
```
1616
Add-WordTable [[-WordDocument] <Container>] [[-Paragraph] <InsertBeforeOrAfter>]
1717
[[-Table] <InsertBeforeOrAfter>] [[-DataTable] <Array>] [[-AutoFit] <AutoFit>] [[-Design] <TableDesign>]
18-
[[-Direction] <Direction>] [-BreakPageAfterTable] [-BreakPageBeforeTable] [[-BreakAcrossPages] <Boolean>]
19-
[[-MaximumColumns] <Int32>] [[-OverwriteTitle] <String>] [-DoNotAddTitle] [[-TitleAlignment] <Alignment>]
20-
[[-ColumnWidth] <Single[]>] [[-TableWidth] <Single>] [[-Percentage] <Boolean>] [[-Color] <Color[]>]
21-
[[-FontSize] <Double[]>] [[-FontFamily] <String[]>] [[-Bold] <Nullable`1[]>] [[-Italic] <Nullable`1[]>]
22-
[[-UnderlineStyle] <UnderlineStyle[]>] [[-UnderlineColor] <Color[]>] [[-SpacingAfter] <Double[]>]
18+
[[-Direction] <Direction>] [-BreakPageAfterTable] [-BreakPageBeforeTable] [[-MaximumColumns] <Int32>]
19+
[[-OverwriteTitle] <String>] [-DoNotAddTitle] [[-TitleAlignment] <Alignment>] [[-ColumnWidth] <Single[]>]
20+
[[-TableWidth] <Single>] [[-Percentage] <Boolean>] [[-Color] <KnownColor[]>] [[-FontSize] <Double[]>]
21+
[[-FontFamily] <String[]>] [[-Bold] <Nullable`1[]>] [[-Italic] <Nullable`1[]>]
22+
[[-UnderlineStyle] <UnderlineStyle[]>] [[-UnderlineColor] <KnownColor[]>] [[-SpacingAfter] <Double[]>]
2323
[[-SpacingBefore] <Double[]>] [[-Spacing] <Double[]>] [[-Highlight] <Highlight[]>]
2424
[[-CapsStyle] <CapsStyle[]>] [[-StrikeThrough] <StrikeThrough[]>] [[-HeadingType] <HeadingType[]>]
2525
[[-PercentageScale] <Int32[]>] [[-Misc] <Misc[]>] [[-Language] <String[]>] [[-Kerning] <Int32[]>]
@@ -54,7 +54,7 @@ Aliases:
5454
Accepted values: left, center, right, both
5555

5656
Required: False
57-
Position: 36
57+
Position: 35
5858
Default value: None
5959
Accept pipeline input: False
6060
Accept wildcard characters: False
@@ -85,22 +85,7 @@ Parameter Sets: (All)
8585
Aliases: B
8686

8787
Required: False
88-
Position: 17
89-
Default value: None
90-
Accept pipeline input: False
91-
Accept wildcard characters: False
92-
```
93-
94-
### -BreakAcrossPages
95-
{{Fill BreakAcrossPages Description}}
96-
97-
```yaml
98-
Type: Boolean
99-
Parameter Sets: (All)
100-
Aliases:
101-
102-
Required: False
103-
Position: 7
88+
Position: 16
10489
Default value: None
10590
Accept pipeline input: False
10691
Accept wildcard characters: False
@@ -146,7 +131,7 @@ Aliases: CA
146131
Accepted values: none, caps, smallCaps
147132

148133
Required: False
149-
Position: 25
134+
Position: 24
150135
Default value: None
151136
Accept pipeline input: False
152137
Accept wildcard characters: False
@@ -156,12 +141,13 @@ Accept wildcard characters: False
156141
{{Fill Color Description}}
157142
158143
```yaml
159-
Type: Color[]
144+
Type: KnownColor[]
160145
Parameter Sets: (All)
161146
Aliases: C
147+
Accepted values: ActiveBorder, ActiveCaption, ActiveCaptionText, AppWorkspace, Control, ControlDark, ControlDarkDark, ControlLight, ControlLightLight, ControlText, Desktop, GrayText, Highlight, HighlightText, HotTrack, InactiveBorder, InactiveCaption, InactiveCaptionText, Info, InfoText, Menu, MenuText, ScrollBar, Window, WindowFrame, WindowText, Transparent, AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black, BlanchedAlmond, Blue, BlueViolet, Brown, BurlyWood, CadetBlue, Chartreuse, Chocolate, Coral, CornflowerBlue, Cornsilk, Crimson, Cyan, DarkBlue, DarkCyan, DarkGoldenrod, DarkGray, DarkGreen, DarkKhaki, DarkMagenta, DarkOliveGreen, DarkOrange, DarkOrchid, DarkRed, DarkSalmon, DarkSeaGreen, DarkSlateBlue, DarkSlateGray, DarkTurquoise, DarkViolet, DeepPink, DeepSkyBlue, DimGray, DodgerBlue, Firebrick, FloralWhite, ForestGreen, Fuchsia, Gainsboro, GhostWhite, Gold, Goldenrod, Gray, Green, GreenYellow, Honeydew, HotPink, IndianRed, Indigo, Ivory, Khaki, Lavender, LavenderBlush, LawnGreen, LemonChiffon, LightBlue, LightCoral, LightCyan, LightGoldenrodYellow, LightGray, LightGreen, LightPink, LightSalmon, LightSeaGreen, LightSkyBlue, LightSlateGray, LightSteelBlue, LightYellow, Lime, LimeGreen, Linen, Magenta, Maroon, MediumAquamarine, MediumBlue, MediumOrchid, MediumPurple, MediumSeaGreen, MediumSlateBlue, MediumSpringGreen, MediumTurquoise, MediumVioletRed, MidnightBlue, MintCream, MistyRose, Moccasin, NavajoWhite, Navy, OldLace, Olive, OliveDrab, Orange, OrangeRed, Orchid, PaleGoldenrod, PaleGreen, PaleTurquoise, PaleVioletRed, PapayaWhip, PeachPuff, Peru, Pink, Plum, PowderBlue, Purple, Red, RosyBrown, RoyalBlue, SaddleBrown, Salmon, SandyBrown, SeaGreen, SeaShell, Sienna, Silver, SkyBlue, SlateBlue, SlateGray, Snow, SpringGreen, SteelBlue, Tan, Teal, Thistle, Tomato, Turquoise, Violet, Wheat, White, WhiteSmoke, Yellow, YellowGreen, ButtonFace, ButtonHighlight, ButtonShadow, GradientActiveCaption, GradientInactiveCaption, MenuBar, MenuHighlight
162148

163149
Required: False
164-
Position: 14
150+
Position: 13
165151
Default value: None
166152
Accept pipeline input: False
167153
Accept wildcard characters: False
@@ -176,7 +162,7 @@ Parameter Sets: (All)
176162
Aliases: ColummnWidth
177163

178164
Required: False
179-
Position: 11
165+
Position: 10
180166
Default value: None
181167
Accept pipeline input: False
182168
Accept wildcard characters: False
@@ -254,7 +240,7 @@ Aliases:
254240
Accepted values: LeftToRight, RightToLeft
255241

256242
Required: False
257-
Position: 37
243+
Position: 36
258244
Default value: None
259245
Accept pipeline input: False
260246
Accept wildcard characters: False
@@ -284,7 +270,7 @@ Parameter Sets: (All)
284270
Aliases:
285271

286272
Required: False
287-
Position: 41
273+
Position: 40
288274
Default value: None
289275
Accept pipeline input: False
290276
Accept wildcard characters: False
@@ -299,7 +285,7 @@ Parameter Sets: (All)
299285
Aliases: FontName
300286

301287
Required: False
302-
Position: 16
288+
Position: 15
303289
Default value: None
304290
Accept pipeline input: False
305291
Accept wildcard characters: False
@@ -314,7 +300,7 @@ Parameter Sets: (All)
314300
Aliases: S
315301

316302
Required: False
317-
Position: 15
303+
Position: 14
318304
Default value: None
319305
Accept pipeline input: False
320306
Accept wildcard characters: False
@@ -330,7 +316,7 @@ Aliases: HT
330316
Accepted values: Heading1, Heading2, Heading3, Heading4, Heading5, Heading6, Heading7, Heading8, Heading9
331317

332318
Required: False
333-
Position: 27
319+
Position: 26
334320
Default value: None
335321
Accept pipeline input: False
336322
Accept wildcard characters: False
@@ -345,7 +331,7 @@ Parameter Sets: (All)
345331
Aliases:
346332

347333
Required: False
348-
Position: 32
334+
Position: 31
349335
Default value: None
350336
Accept pipeline input: False
351337
Accept wildcard characters: False
@@ -361,7 +347,7 @@ Aliases: H
361347
Accepted values: yellow, green, cyan, magenta, blue, red, darkBlue, darkCyan, darkGreen, darkMagenta, darkRed, darkYellow, darkGray, lightGray, black, none
362348

363349
Required: False
364-
Position: 24
350+
Position: 23
365351
Default value: None
366352
Accept pipeline input: False
367353
Accept wildcard characters: False
@@ -376,7 +362,7 @@ Parameter Sets: (All)
376362
Aliases:
377363

378364
Required: False
379-
Position: 34
365+
Position: 33
380366
Default value: None
381367
Accept pipeline input: False
382368
Accept wildcard characters: False
@@ -391,7 +377,7 @@ Parameter Sets: (All)
391377
Aliases:
392378

393379
Required: False
394-
Position: 35
380+
Position: 34
395381
Default value: None
396382
Accept pipeline input: False
397383
Accept wildcard characters: False
@@ -406,7 +392,7 @@ Parameter Sets: (All)
406392
Aliases: I
407393

408394
Required: False
409-
Position: 18
395+
Position: 17
410396
Default value: None
411397
Accept pipeline input: False
412398
Accept wildcard characters: False
@@ -451,7 +437,7 @@ Parameter Sets: (All)
451437
Aliases:
452438

453439
Required: False
454-
Position: 31
440+
Position: 30
455441
Default value: None
456442
Accept pipeline input: False
457443
Accept wildcard characters: False
@@ -466,7 +452,7 @@ Parameter Sets: (All)
466452
Aliases:
467453

468454
Required: False
469-
Position: 30
455+
Position: 29
470456
Default value: None
471457
Accept pipeline input: False
472458
Accept wildcard characters: False
@@ -481,7 +467,7 @@ Parameter Sets: (All)
481467
Aliases:
482468

483469
Required: False
484-
Position: 8
470+
Position: 7
485471
Default value: None
486472
Accept pipeline input: False
487473
Accept wildcard characters: False
@@ -497,7 +483,7 @@ Aliases:
497483
Accepted values: none, shadow, outline, outlineShadow, emboss, engrave
498484

499485
Required: False
500-
Position: 29
486+
Position: 28
501487
Default value: None
502488
Accept pipeline input: False
503489
Accept wildcard characters: False
@@ -512,7 +498,7 @@ Parameter Sets: (All)
512498
Aliases:
513499

514500
Required: False
515-
Position: 40
501+
Position: 39
516502
Default value: None
517503
Accept pipeline input: False
518504
Accept wildcard characters: False
@@ -527,7 +513,7 @@ Parameter Sets: (All)
527513
Aliases:
528514

529515
Required: False
530-
Position: 9
516+
Position: 8
531517
Default value: None
532518
Accept pipeline input: False
533519
Accept wildcard characters: False
@@ -557,7 +543,7 @@ Parameter Sets: (All)
557543
Aliases:
558544

559545
Required: False
560-
Position: 13
546+
Position: 12
561547
Default value: None
562548
Accept pipeline input: False
563549
Accept wildcard characters: False
@@ -572,7 +558,7 @@ Parameter Sets: (All)
572558
Aliases:
573559

574560
Required: False
575-
Position: 28
561+
Position: 27
576562
Default value: None
577563
Accept pipeline input: False
578564
Accept wildcard characters: False
@@ -587,7 +573,7 @@ Parameter Sets: (All)
587573
Aliases:
588574

589575
Required: False
590-
Position: 33
576+
Position: 32
591577
Default value: None
592578
Accept pipeline input: False
593579
Accept wildcard characters: False
@@ -603,7 +589,7 @@ Aliases:
603589
Accepted values: superscript, subscript, none
604590

605591
Required: False
606-
Position: 39
592+
Position: 38
607593
Default value: None
608594
Accept pipeline input: False
609595
Accept wildcard characters: False
@@ -619,7 +605,7 @@ Aliases:
619605
Accepted values: Text, Paragraph
620606

621607
Required: False
622-
Position: 38
608+
Position: 37
623609
Default value: None
624610
Accept pipeline input: False
625611
Accept wildcard characters: False
@@ -634,7 +620,7 @@ Parameter Sets: (All)
634620
Aliases: SP
635621

636622
Required: False
637-
Position: 23
623+
Position: 22
638624
Default value: None
639625
Accept pipeline input: False
640626
Accept wildcard characters: False
@@ -649,7 +635,7 @@ Parameter Sets: (All)
649635
Aliases: SA
650636

651637
Required: False
652-
Position: 21
638+
Position: 20
653639
Default value: None
654640
Accept pipeline input: False
655641
Accept wildcard characters: False
@@ -664,7 +650,7 @@ Parameter Sets: (All)
664650
Aliases: SB
665651

666652
Required: False
667-
Position: 22
653+
Position: 21
668654
Default value: None
669655
Accept pipeline input: False
670656
Accept wildcard characters: False
@@ -679,7 +665,7 @@ Parameter Sets: (All)
679665
Aliases:
680666

681667
Required: False
682-
Position: 43
668+
Position: 42
683669
Default value: None
684670
Accept pipeline input: False
685671
Accept wildcard characters: False
@@ -695,7 +681,7 @@ Aliases: ST
695681
Accepted values: none, strike, doubleStrike
696682

697683
Required: False
698-
Position: 26
684+
Position: 25
699685
Default value: None
700686
Accept pipeline input: False
701687
Accept wildcard characters: False
@@ -710,7 +696,7 @@ Parameter Sets: (All)
710696
Aliases:
711697

712698
Required: False
713-
Position: 42
699+
Position: 41
714700
Default value: None
715701
Accept pipeline input: False
716702
Accept wildcard characters: False
@@ -740,7 +726,7 @@ Parameter Sets: (All)
740726
Aliases:
741727

742728
Required: False
743-
Position: 12
729+
Position: 11
744730
Default value: None
745731
Accept pipeline input: False
746732
Accept wildcard characters: False
@@ -756,7 +742,7 @@ Aliases:
756742
Accepted values: left, center, right, both
757743

758744
Required: False
759-
Position: 10
745+
Position: 9
760746
Default value: None
761747
Accept pipeline input: False
762748
Accept wildcard characters: False
@@ -781,12 +767,13 @@ Accept wildcard characters: False
781767
{{Fill UnderlineColor Description}}
782768
783769
```yaml
784-
Type: Color[]
770+
Type: KnownColor[]
785771
Parameter Sets: (All)
786772
Aliases: UC
773+
Accepted values: ActiveBorder, ActiveCaption, ActiveCaptionText, AppWorkspace, Control, ControlDark, ControlDarkDark, ControlLight, ControlLightLight, ControlText, Desktop, GrayText, Highlight, HighlightText, HotTrack, InactiveBorder, InactiveCaption, InactiveCaptionText, Info, InfoText, Menu, MenuText, ScrollBar, Window, WindowFrame, WindowText, Transparent, AliceBlue, AntiqueWhite, Aqua, Aquamarine, Azure, Beige, Bisque, Black, BlanchedAlmond, Blue, BlueViolet, Brown, BurlyWood, CadetBlue, Chartreuse, Chocolate, Coral, CornflowerBlue, Cornsilk, Crimson, Cyan, DarkBlue, DarkCyan, DarkGoldenrod, DarkGray, DarkGreen, DarkKhaki, DarkMagenta, DarkOliveGreen, DarkOrange, DarkOrchid, DarkRed, DarkSalmon, DarkSeaGreen, DarkSlateBlue, DarkSlateGray, DarkTurquoise, DarkViolet, DeepPink, DeepSkyBlue, DimGray, DodgerBlue, Firebrick, FloralWhite, ForestGreen, Fuchsia, Gainsboro, GhostWhite, Gold, Goldenrod, Gray, Green, GreenYellow, Honeydew, HotPink, IndianRed, Indigo, Ivory, Khaki, Lavender, LavenderBlush, LawnGreen, LemonChiffon, LightBlue, LightCoral, LightCyan, LightGoldenrodYellow, LightGray, LightGreen, LightPink, LightSalmon, LightSeaGreen, LightSkyBlue, LightSlateGray, LightSteelBlue, LightYellow, Lime, LimeGreen, Linen, Magenta, Maroon, MediumAquamarine, MediumBlue, MediumOrchid, MediumPurple, MediumSeaGreen, MediumSlateBlue, MediumSpringGreen, MediumTurquoise, MediumVioletRed, MidnightBlue, MintCream, MistyRose, Moccasin, NavajoWhite, Navy, OldLace, Olive, OliveDrab, Orange, OrangeRed, Orchid, PaleGoldenrod, PaleGreen, PaleTurquoise, PaleVioletRed, PapayaWhip, PeachPuff, Peru, Pink, Plum, PowderBlue, Purple, Red, RosyBrown, RoyalBlue, SaddleBrown, Salmon, SandyBrown, SeaGreen, SeaShell, Sienna, Silver, SkyBlue, SlateBlue, SlateGray, Snow, SpringGreen, SteelBlue, Tan, Teal, Thistle, Tomato, Turquoise, Violet, Wheat, White, WhiteSmoke, Yellow, YellowGreen, ButtonFace, ButtonHighlight, ButtonShadow, GradientActiveCaption, GradientInactiveCaption, MenuBar, MenuHighlight
787774

788775
Required: False
789-
Position: 20
776+
Position: 19
790777
Default value: None
791778
Accept pipeline input: False
792779
Accept wildcard characters: False
@@ -802,7 +789,7 @@ Aliases: U
802789
Accepted values: none, singleLine, words, doubleLine, dotted, thick, dash, dotDash, dotDotDash, wave, dottedHeavy, dashedHeavy, dashDotHeavy, dashDotDotHeavy, dashLongHeavy, dashLong, wavyDouble, wavyHeavy
803790

804791
Required: False
805-
Position: 19
792+
Position: 18
806793
Default value: None
807794
Accept pipeline input: False
808795
Accept wildcard characters: False

0 commit comments

Comments
 (0)