Skip to content

Commit fb03437

Browse files
ElizabethSamuel-MSFTgithub-actions
ElizabethSamuel-MSFT
and
github-actions
authored
Automatically generated docs (#2190)
* Automatically generated docs * Get latest * Update Word preview APIs --------- Co-authored-by: github-actions <[email protected]>
1 parent fedffca commit fb03437

File tree

39 files changed

+1046
-726
lines changed

39 files changed

+1046
-726
lines changed

‎docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontdata.yml

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,78 +14,79 @@ properties:
1414
package: powerpoint!
1515
fullName: bold
1616
summary: >-
17-
Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text
17+
Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text
1818
fragments.
1919
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
2020
isPreview: false
2121
isDeprecated: false
2222
syntax:
23-
content: 'bold?: boolean;'
23+
content: 'bold?: boolean | null;'
2424
return:
25-
type: boolean
25+
type: boolean | null
2626
- name: color
2727
uid: 'powerpoint!PowerPoint.Interfaces.ShapeFontData#color:member'
2828
package: powerpoint!
2929
fullName: color
3030
summary: >-
31-
HTML color code representation of the text color (e.g., "\#FF0000" represents red). Returns `null` if the
32-
`TextRange` includes text fragments with different colors.
31+
Specifies the HTML color code representation of the text color (e.g., "\#FF0000" represents red). Returns `null`
32+
if the `TextRange` contains text fragments with different colors.
3333
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
3434
isPreview: false
3535
isDeprecated: false
3636
syntax:
37-
content: 'color?: string;'
37+
content: 'color?: string | null;'
3838
return:
39-
type: string
39+
type: string | null
4040
- name: italic
4141
uid: 'powerpoint!PowerPoint.Interfaces.ShapeFontData#italic:member'
4242
package: powerpoint!
4343
fullName: italic
4444
summary: >-
45-
Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text
45+
Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text
4646
fragments.
4747
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
4848
isPreview: false
4949
isDeprecated: false
5050
syntax:
51-
content: 'italic?: boolean;'
51+
content: 'italic?: boolean | null;'
5252
return:
53-
type: boolean
53+
type: boolean | null
5454
- name: name
5555
uid: 'powerpoint!PowerPoint.Interfaces.ShapeFontData#name:member'
5656
package: powerpoint!
5757
fullName: name
5858
summary: >-
59-
Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the
60-
corresponding font name; otherwise it is the Latin font name.
59+
Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the
60+
corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text
61+
fragments with different font names.
6162
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
6263
isPreview: false
6364
isDeprecated: false
6465
syntax:
65-
content: 'name?: string;'
66+
content: 'name?: string | null;'
6667
return:
67-
type: string
68+
type: string | null
6869
- name: size
6970
uid: 'powerpoint!PowerPoint.Interfaces.ShapeFontData#size:member'
7071
package: powerpoint!
7172
fullName: size
7273
summary: >-
73-
Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different
74-
font sizes.
74+
Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with
75+
different font sizes.
7576
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
7677
isPreview: false
7778
isDeprecated: false
7879
syntax:
79-
content: 'size?: number;'
80+
content: 'size?: number | null;'
8081
return:
81-
type: number
82+
type: number | null
8283
- name: underline
8384
uid: 'powerpoint!PowerPoint.Interfaces.ShapeFontData#underline:member'
8485
package: powerpoint!
8586
fullName: underline
8687
summary: >-
87-
Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different
88-
underline styles. See
88+
Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments
89+
with different underline styles. See
8990
[PowerPoint.ShapeFontUnderlineStyle](xref:powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum) for details.
9091
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
9192
isPreview: false
@@ -94,9 +95,9 @@ properties:
9495
content: >-
9596
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" |
9697
"DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash"
97-
| "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
98+
| "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
9899
return:
99100
type: >-
100101
<xref uid="powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum" /> | "None" | "Single" | "Double" | "Heavy" |
101102
"Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" |
102-
"DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"
103+
"DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null

‎docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontloadoptions.yml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ properties:
2828
package: powerpoint!
2929
fullName: bold
3030
summary: >-
31-
Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text
31+
Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text
3232
fragments.
3333
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
3434
isPreview: false
@@ -42,8 +42,8 @@ properties:
4242
package: powerpoint!
4343
fullName: color
4444
summary: >-
45-
HTML color code representation of the text color (e.g., "\#FF0000" represents red). Returns `null` if the
46-
`TextRange` includes text fragments with different colors.
45+
Specifies the HTML color code representation of the text color (e.g., "\#FF0000" represents red). Returns `null`
46+
if the `TextRange` contains text fragments with different colors.
4747
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
4848
isPreview: false
4949
isDeprecated: false
@@ -56,7 +56,7 @@ properties:
5656
package: powerpoint!
5757
fullName: italic
5858
summary: >-
59-
Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text
59+
Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text
6060
fragments.
6161
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
6262
isPreview: false
@@ -70,8 +70,9 @@ properties:
7070
package: powerpoint!
7171
fullName: name
7272
summary: >-
73-
Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the
74-
corresponding font name; otherwise it is the Latin font name.
73+
Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the
74+
corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text
75+
fragments with different font names.
7576
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
7677
isPreview: false
7778
isDeprecated: false
@@ -84,8 +85,8 @@ properties:
8485
package: powerpoint!
8586
fullName: size
8687
summary: >-
87-
Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different
88-
font sizes.
88+
Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with
89+
different font sizes.
8990
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
9091
isPreview: false
9192
isDeprecated: false
@@ -98,8 +99,8 @@ properties:
9899
package: powerpoint!
99100
fullName: underline
100101
summary: >-
101-
Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different
102-
underline styles. See
102+
Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments
103+
with different underline styles. See
103104
[PowerPoint.ShapeFontUnderlineStyle](xref:powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum) for details.
104105
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
105106
isPreview: false

‎docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.shapefontupdatedata.yml

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,78 +14,79 @@ properties:
1414
package: powerpoint!
1515
fullName: bold
1616
summary: >-
17-
Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text
17+
Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text
1818
fragments.
1919
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
2020
isPreview: false
2121
isDeprecated: false
2222
syntax:
23-
content: 'bold?: boolean;'
23+
content: 'bold?: boolean | null;'
2424
return:
25-
type: boolean
25+
type: boolean | null
2626
- name: color
2727
uid: 'powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#color:member'
2828
package: powerpoint!
2929
fullName: color
3030
summary: >-
31-
HTML color code representation of the text color (e.g., "\#FF0000" represents red). Returns `null` if the
32-
`TextRange` includes text fragments with different colors.
31+
Specifies the HTML color code representation of the text color (e.g., "\#FF0000" represents red). Returns `null`
32+
if the `TextRange` contains text fragments with different colors.
3333
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
3434
isPreview: false
3535
isDeprecated: false
3636
syntax:
37-
content: 'color?: string;'
37+
content: 'color?: string | null;'
3838
return:
39-
type: string
39+
type: string | null
4040
- name: italic
4141
uid: 'powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#italic:member'
4242
package: powerpoint!
4343
fullName: italic
4444
summary: >-
45-
Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text
45+
Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text
4646
fragments.
4747
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
4848
isPreview: false
4949
isDeprecated: false
5050
syntax:
51-
content: 'italic?: boolean;'
51+
content: 'italic?: boolean | null;'
5252
return:
53-
type: boolean
53+
type: boolean | null
5454
- name: name
5555
uid: 'powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#name:member'
5656
package: powerpoint!
5757
fullName: name
5858
summary: >-
59-
Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the
60-
corresponding font name; otherwise it is the Latin font name.
59+
Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the
60+
corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text
61+
fragments with different font names.
6162
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
6263
isPreview: false
6364
isDeprecated: false
6465
syntax:
65-
content: 'name?: string;'
66+
content: 'name?: string | null;'
6667
return:
67-
type: string
68+
type: string | null
6869
- name: size
6970
uid: 'powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#size:member'
7071
package: powerpoint!
7172
fullName: size
7273
summary: >-
73-
Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different
74-
font sizes.
74+
Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with
75+
different font sizes.
7576
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
7677
isPreview: false
7778
isDeprecated: false
7879
syntax:
79-
content: 'size?: number;'
80+
content: 'size?: number | null;'
8081
return:
81-
type: number
82+
type: number | null
8283
- name: underline
8384
uid: 'powerpoint!PowerPoint.Interfaces.ShapeFontUpdateData#underline:member'
8485
package: powerpoint!
8586
fullName: underline
8687
summary: >-
87-
Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different
88-
underline styles. See
88+
Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments
89+
with different underline styles. See
8990
[PowerPoint.ShapeFontUnderlineStyle](xref:powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum) for details.
9091
remarks: '\[ [API set: PowerPointApi 1.4](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \]'
9192
isPreview: false
@@ -94,9 +95,9 @@ properties:
9495
content: >-
9596
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" |
9697
"DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash"
97-
| "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
98+
| "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
9899
return:
99100
type: >-
100101
<xref uid="powerpoint!PowerPoint.ShapeFontUnderlineStyle:enum" /> | "None" | "Single" | "Double" | "Heavy" |
101102
"Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" |
102-
"DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"
103+
"DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null

0 commit comments

Comments
 (0)