|
| 1 | +### YamlMime:TSType |
| 2 | +name: PowerPoint.PlaceholderFormat |
| 3 | +uid: 'powerpoint!PowerPoint.PlaceholderFormat:class' |
| 4 | +package: powerpoint! |
| 5 | +fullName: PowerPoint.PlaceholderFormat |
| 6 | +summary: Represents the properties of a `placeholder` shape. |
| 7 | +remarks: >- |
| 8 | + \[ [API set: PowerPointApi BETA (PREVIEW |
| 9 | + ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] |
| 10 | +isPreview: true |
| 11 | +isDeprecated: false |
| 12 | +type: class |
| 13 | +properties: |
| 14 | + - name: containedType |
| 15 | + uid: 'powerpoint!PowerPoint.PlaceholderFormat#containedType:member' |
| 16 | + package: powerpoint! |
| 17 | + fullName: containedType |
| 18 | + summary: >- |
| 19 | + Gets the type of the shape contained within the placeholder. See |
| 20 | + [PowerPoint.ShapeType](xref:powerpoint!PowerPoint.ShapeType:enum) for details. Returns `null` if the placeholder |
| 21 | + is empty. |
| 22 | + remarks: >- |
| 23 | + \[ [API set: PowerPointApi BETA (PREVIEW |
| 24 | + ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] |
| 25 | + isPreview: true |
| 26 | + isDeprecated: false |
| 27 | + syntax: |
| 28 | + content: 'readonly containedType: ShapeType | null;' |
| 29 | + return: |
| 30 | + type: '<xref uid="powerpoint!PowerPoint.ShapeType:enum" /> | null' |
| 31 | + - name: context |
| 32 | + uid: 'powerpoint!PowerPoint.PlaceholderFormat#context:member' |
| 33 | + package: powerpoint! |
| 34 | + fullName: context |
| 35 | + summary: >- |
| 36 | + The request context associated with the object. This connects the add-in's process to the Office host |
| 37 | + application's process. |
| 38 | + remarks: '' |
| 39 | + isPreview: true |
| 40 | + isDeprecated: false |
| 41 | + syntax: |
| 42 | + content: 'context: RequestContext;' |
| 43 | + return: |
| 44 | + type: '<xref uid="powerpoint!PowerPoint.RequestContext:class" />' |
| 45 | + - name: type |
| 46 | + uid: 'powerpoint!PowerPoint.PlaceholderFormat#type:member' |
| 47 | + package: powerpoint! |
| 48 | + fullName: type |
| 49 | + summary: >- |
| 50 | + Returns the type of this placeholder. See |
| 51 | + [PowerPoint.PlaceholderType](xref:powerpoint!PowerPoint.PlaceholderType:enum) for details. |
| 52 | + remarks: >- |
| 53 | + \[ [API set: PowerPointApi BETA (PREVIEW |
| 54 | + ONLY)](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] |
| 55 | + isPreview: true |
| 56 | + isDeprecated: false |
| 57 | + syntax: |
| 58 | + content: >- |
| 59 | + readonly type: PowerPoint.PlaceholderType | "Unsupported" | "Date" | "SlideNumber" | "Footer" | "Header" | |
| 60 | + "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | "Chart" | "Table" |
| 61 | + | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo"; |
| 62 | + return: |
| 63 | + type: >- |
| 64 | + <xref uid="powerpoint!PowerPoint.PlaceholderType:enum" /> | "Unsupported" | "Date" | "SlideNumber" | "Footer" |
| 65 | + | "Header" | "Title" | "Body" | "CenterTitle" | "Subtitle" | "VerticalTitle" | "VerticalBody" | "Content" | |
| 66 | + "Chart" | "Table" | "OnlinePicture" | "SmartArt" | "Media" | "VerticalContent" | "Picture" | "Cameo" |
| 67 | +methods: |
| 68 | + - name: load(options) |
| 69 | + uid: 'powerpoint!PowerPoint.PlaceholderFormat#load:member(1)' |
| 70 | + package: powerpoint! |
| 71 | + fullName: load(options) |
| 72 | + summary: >- |
| 73 | + Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading |
| 74 | + the properties. |
| 75 | + remarks: '' |
| 76 | + isPreview: true |
| 77 | + isDeprecated: false |
| 78 | + syntax: |
| 79 | + content: 'load(options?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions): PowerPoint.PlaceholderFormat;' |
| 80 | + parameters: |
| 81 | + - id: options |
| 82 | + description: Provides options for which properties of the object to load. |
| 83 | + type: '<xref uid="powerpoint!PowerPoint.Interfaces.PlaceholderFormatLoadOptions:interface" />' |
| 84 | + return: |
| 85 | + type: '<xref uid="powerpoint!PowerPoint.PlaceholderFormat:class" />' |
| 86 | + description: '' |
| 87 | + - name: load(propertyNames) |
| 88 | + uid: 'powerpoint!PowerPoint.PlaceholderFormat#load:member(2)' |
| 89 | + package: powerpoint! |
| 90 | + fullName: load(propertyNames) |
| 91 | + summary: >- |
| 92 | + Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading |
| 93 | + the properties. |
| 94 | + remarks: '' |
| 95 | + isPreview: true |
| 96 | + isDeprecated: false |
| 97 | + syntax: |
| 98 | + content: 'load(propertyNames?: string | string[]): PowerPoint.PlaceholderFormat;' |
| 99 | + parameters: |
| 100 | + - id: propertyNames |
| 101 | + description: A comma-delimited string or an array of strings that specify the properties to load. |
| 102 | + type: 'string | string[]' |
| 103 | + return: |
| 104 | + type: '<xref uid="powerpoint!PowerPoint.PlaceholderFormat:class" />' |
| 105 | + description: '' |
| 106 | + - name: load(propertyNamesAndPaths) |
| 107 | + uid: 'powerpoint!PowerPoint.PlaceholderFormat#load:member(3)' |
| 108 | + package: powerpoint! |
| 109 | + fullName: load(propertyNamesAndPaths) |
| 110 | + summary: >- |
| 111 | + Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading |
| 112 | + the properties. |
| 113 | + remarks: '' |
| 114 | + isPreview: true |
| 115 | + isDeprecated: false |
| 116 | + syntax: |
| 117 | + content: |- |
| 118 | + load(propertyNamesAndPaths?: { |
| 119 | + select?: string; |
| 120 | + expand?: string; |
| 121 | + }): PowerPoint.PlaceholderFormat; |
| 122 | + parameters: |
| 123 | + - id: propertyNamesAndPaths |
| 124 | + description: >- |
| 125 | + `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and |
| 126 | + `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. |
| 127 | + type: |- |
| 128 | + { |
| 129 | + select?: string; |
| 130 | + expand?: string; |
| 131 | + } |
| 132 | + return: |
| 133 | + type: '<xref uid="powerpoint!PowerPoint.PlaceholderFormat:class" />' |
| 134 | + description: '' |
| 135 | + - name: toJSON() |
| 136 | + uid: 'powerpoint!PowerPoint.PlaceholderFormat#toJSON:member(1)' |
| 137 | + package: powerpoint! |
| 138 | + fullName: toJSON() |
| 139 | + summary: >- |
| 140 | + Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to |
| 141 | + `JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that's |
| 142 | + passed to it.) Whereas the original `PowerPoint.PlaceholderFormat` object is an API object, the `toJSON` method |
| 143 | + returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PlaceholderFormatData`<!-- -->) that contains |
| 144 | + shallow copies of any loaded child properties from the original object. |
| 145 | + remarks: '' |
| 146 | + isPreview: true |
| 147 | + isDeprecated: false |
| 148 | + syntax: |
| 149 | + content: 'toJSON(): PowerPoint.Interfaces.PlaceholderFormatData;' |
| 150 | + return: |
| 151 | + type: '<xref uid="powerpoint!PowerPoint.Interfaces.PlaceholderFormatData:interface" />' |
| 152 | + description: '' |
| 153 | +extends: '<xref uid="office!OfficeExtension.ClientObject:class" />' |
0 commit comments