-
Notifications
You must be signed in to change notification settings - Fork 13
/
HTMLProject.xml
301 lines (301 loc) · 20 KB
/
HTMLProject.xml
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
<Type Name="HTMLProject" FullName="Microsoft.Office.Core.HTMLProject">
<TypeSignature Language="C++ CLI" Value="public interface class HTMLProject : Microsoft::Office::Core::_IMsoDispObj" />
<TypeSignature Language="C#" Value="public interface HTMLProject : Microsoft.Office.Core._IMsoDispObj" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract HTMLProject implements class Microsoft.Office.Core._IMsoDispObj" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.Core.HTMLProject" />
<TypeSignature Language="VB.NET" Value="Public Interface HTMLProject
Implements _IMsoDispObj" />
<TypeSignature Language="F#" Value="type HTMLProject = interface
 interface _IMsoDispObj" />
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Office.Core._IMsoDispObj</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.Guid("000C0356-0000-0000-C000-000000000046")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.Guid("000C0356-0000-0000-C000-000000000046")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.TypeLibType(4304)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.TypeLibType(4304)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a top-level project branch, as in the Project Explorer in the Microsoft Script Editor.</summary>
<remarks>
<para>Use the <see cref="M:Microsoft.Office.Core.HTMLProject.Open(Microsoft.Office.Core.MsoHTMLProjectOpen)" /> method of the <see cref="T:Microsoft.Office.Core.HTMLProject" /> object to open an HTML project in the Microsoft Script Editor. The project is opened in source view or text view for the active Microsoft Word document, Excel workbook, or PowerPoint presentation.</para>
<para>Use the <see cref="T:Microsoft.Office.Core.HTMLProjectItems" /> property to return the collection of <b>HTMLProjectItem</b> objects in the HTML project. Use the <see cref="M:Microsoft.Office.Core.HTMLProject.RefreshDocument(System.Boolean)" /> method to refresh the HTML document in the host application. Use the <see cref="M:Microsoft.Office.Core.HTMLProject.RefreshProject(System.Boolean)" /> method to refresh the project in the Microsoft Script Editor. Use the <see cref="P:Microsoft.Office.Core.HTMLProject.State" /> method to determine whether the HTML project needs to be refreshed.</para>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName="Application">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Object ^ Application { System::Object ^ get(); };" />
<MemberSignature Language="C#" Value="public object Application { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Application" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.HTMLProject.Application" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Application As Object" />
<MemberSignature Language="F#" Value="member this.Application : obj" Usage="Microsoft.Office.Core.HTMLProject.Application" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Office.Core._IMsoDispObj.Application</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(1610743808)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(1610743808)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(1610743808)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(1610743808)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns an <b>Application</b> object that represents the container application for the object.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Creator">
<MemberSignature Language="C++ CLI" Value="public:
 property int Creator { int get(); };" />
<MemberSignature Language="C#" Value="public int Creator { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Creator" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.HTMLProject.Creator" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Creator As Integer" />
<MemberSignature Language="F#" Value="member this.Creator : int" Usage="Microsoft.Office.Core.HTMLProject.Creator" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Office.Core._IMsoDispObj.Creator</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(1610743809)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(1610743809)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(1610743809)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(1610743809)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a 32-bit integer that indicates the application in which the specified object was created.</summary>
<value>To be added.</value>
<remarks>
<para>If the object was created in Microsoft Word, this property returns 1297307460, which represents the string MSWD; if created in Microsoft Excel, this property returns 1480803660. This value can also be represented by the constant <b>wdCreatorCode</b> in Word, or <b>xlCreatorCode</b> in Excel.</para>
<para>The <b>Creator</b> property was primarily designed to be used on the Macintosh, where each application has a four-character creator code. For example, Microsoft Word has the creator code MSWD. For additional information about this property, consult the language reference Help included with Microsoft Office Macintosh Edition.</para>
<para>The <b>Creator</b> property always returns the numeric identifier for the active application, just as the <see cref="P:Microsoft.Office.Core.HTMLProject.Application" /> property always returns the name of the active application in string form. Use the <b>CreatedBy</b> property of the <see cref="T:Microsoft.Office.Core.SharedWorkspaceFile" />, <see cref="T:Microsoft.Office.Core.SharedWorkspaceFolder" />, <see cref="T:Microsoft.Office.Core.SharedWorkspaceLink" />, and <see cref="T:Microsoft.Office.Core.SharedWorkspaceTask" /> objects to return the name of the individual who created those objects. Use document properties to return information about the authors of Office documents.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="HTMLProjectItems">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Office::Core::HTMLProjectItems ^ HTMLProjectItems { Microsoft::Office::Core::HTMLProjectItems ^ get(); };" />
<MemberSignature Language="C#" Value="public Microsoft.Office.Core.HTMLProjectItems HTMLProjectItems { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.Core.HTMLProjectItems HTMLProjectItems" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.HTMLProject.HTMLProjectItems" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property HTMLProjectItems As HTMLProjectItems" />
<MemberSignature Language="F#" Value="member this.HTMLProjectItems : Microsoft.Office.Core.HTMLProjectItems" Usage="Microsoft.Office.Core.HTMLProject.HTMLProjectItems" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(3)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(3)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(3)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(3)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Office.Core.HTMLProjectItems</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the <see cref="T:Microsoft.Office.Core.HTMLProjectItems" /> collection that is included in the specified HTML project.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Open">
<MemberSignature Language="C#" Value="public void Open (Microsoft.Office.Core.MsoHTMLProjectOpen OpenKind = (Microsoft.Office.Core.MsoHTMLProjectOpen) 0);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Open([in]valuetype Microsoft.Office.Core.MsoHTMLProjectOpen OpenKind) runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Core.HTMLProject.Open(Microsoft.Office.Core.MsoHTMLProjectOpen)" />
<MemberSignature Language="VB.NET" Value="Public Sub Open (Optional OpenKind As MsoHTMLProjectOpen = (Microsoft.Office.Core.MsoHTMLProjectOpen) 0)" />
<MemberSignature Language="F#" Value="abstract member Open : Microsoft.Office.Core.MsoHTMLProjectOpen -> unit" Usage="hTMLProject.Open OpenKind" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(5)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(5)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="OpenKind" Type="Microsoft.Office.Core.MsoHTMLProjectOpen" />
</Parameters>
<Docs>
<param name="OpenKind">Optional <see cref="T:Microsoft.Office.Core.MsoHTMLProjectOpen" />. The view in which the specified project or project item is opened.</param>
<summary>Opens the specified HTML project or HTML project item in the Microsoft Script Editor in one of the views specified by the optional <see cref="T:Microsoft.Office.Core.MsoHTMLProjectOpen" /> constants.</summary>
<remarks>
<para>If one of the constants is not specified, the project item is opened in the default view.</para>
<para>The default view is determined by whether or not the Microsoft Script Editor is open when the <b>Open</b> method is executed. If the Script Editor is not open, the <b>Open</b> method starts the Script Editor in source view. If the Script Editor is already open, the <b>Open</b> method activates the Script Editor and displays the script in the current view.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Parent">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Object ^ Parent { System::Object ^ get(); };" />
<MemberSignature Language="C#" Value="public object Parent { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Parent" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.HTMLProject.Parent" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Parent As Object" />
<MemberSignature Language="F#" Value="member this.Parent : obj" Usage="Microsoft.Office.Core.HTMLProject.Parent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(4)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(4)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(4)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(4)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the <b>Parent</b> object for the specified object.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RefreshDocument">
<MemberSignature Language="C#" Value="public void RefreshDocument (bool Refresh = false);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void RefreshDocument([in]bool Refresh) runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Core.HTMLProject.RefreshDocument(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub RefreshDocument (Optional Refresh As Boolean = false)" />
<MemberSignature Language="F#" Value="abstract member RefreshDocument : bool -> unit" Usage="hTMLProject.RefreshDocument Refresh" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(2)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="Refresh" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="Refresh">Optional <b>Boolean</b>. <b>True</b> if all changes are to be saved; <b>False</b> if all changes are to be ignored.</param>
<summary>Refreshes the specified HTML project in the Microsoft Office host application.</summary>
<remarks>
<para>Using this method is equivalent to clicking the Refresh button on the Refresh toolbar in the Office host application. If you refresh the document by setting the <b>RefreshDocument</b> method to <b>True</b>, all changes to the HTML source made in the Microsoft Script Editor are saved in the Office host application. If you set <b>RefreshDocument</b> to <b>False</b>, all changes to the HTML source are ignored.</para>
<para>Note that the value returned by the <see cref="P:Microsoft.Office.Core.HTMLProject.State" /> property is affected by the <b>RefreshDocument</b> method. If you call RefreshDocument(True), the <b>State</b> property returns <b>msoHTMLProjectStateDocumentProjectUnlocked</b> if it is called after the refresh operation.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="RefreshProject">
<MemberSignature Language="C#" Value="public void RefreshProject (bool Refresh = false);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void RefreshProject([in]bool Refresh) runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Core.HTMLProject.RefreshProject(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub RefreshProject (Optional Refresh As Boolean = false)" />
<MemberSignature Language="F#" Value="abstract member RefreshProject : bool -> unit" Usage="hTMLProject.RefreshProject Refresh" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="Refresh" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="Refresh">Optional <b>Boolean</b>. <b>True</b> if the document will be refreshed; <b>False</b> if the document will not be refreshed.</param>
<summary>Refreshes the specified HTML project in the Microsoft Script Editor.</summary>
<remarks>
<para>Using this method is equivalent to clicking the Refresh button on the Refresh toolbar in the Microsoft Script Editor. If you refresh the document by setting <see cref="M:Microsoft.Office.Core.HTMLProject.RefreshDocument(System.Boolean)" /> to <b>True</b>, all changes to the HTML source made in the Office host application are saved to the HTML project in the Microsoft Script Editor. If you set <b>RefreshDocument</b> to <b>False</b>, all changes to the HTML source are ignored.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="State">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Office::Core::MsoHTMLProjectState default { Microsoft::Office::Core::MsoHTMLProjectState get(); };" />
<MemberSignature Language="C#" Value="public Microsoft.Office.Core.MsoHTMLProjectState this { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Office.Core.MsoHTMLProjectState State" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.HTMLProject.State" />
<MemberSignature Language="VB.NET" Value="Default Public ReadOnly Property State As MsoHTMLProjectState" />
<MemberSignature Language="F#" Value="member this.State : Microsoft.Office.Core.MsoHTMLProjectState" Usage="Microsoft.Office.Core.HTMLProject.State" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(0)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(0)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(0)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Office.Core.MsoHTMLProjectState</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the current state of an <see cref="T:Microsoft.Office.Core.HTMLProject" /> object.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>