-
Notifications
You must be signed in to change notification settings - Fork 13
/
HTMLProjectItem.xml
336 lines (336 loc) · 20.5 KB
/
HTMLProjectItem.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
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
<Type Name="HTMLProjectItem" FullName="Microsoft.Office.Core.HTMLProjectItem">
<TypeSignature Language="C++ CLI" Value="public interface class HTMLProjectItem : Microsoft::Office::Core::_IMsoDispObj" />
<TypeSignature Language="C#" Value="public interface HTMLProjectItem : Microsoft.Office.Core._IMsoDispObj" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract HTMLProjectItem implements class Microsoft.Office.Core._IMsoDispObj" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.Core.HTMLProjectItem" />
<TypeSignature Language="VB.NET" Value="Public Interface HTMLProjectItem
Implements _IMsoDispObj" />
<TypeSignature Language="F#" Value="type HTMLProjectItem = 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("000C0358-0000-0000-C000-000000000046")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.Guid("000C0358-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 an individual project item that’s a project item branch in the Project Explorer in the Microsoft Script Editor.</summary>
<remarks>
<para>The <b>HTMLProjectItem</b> object is a member of the <see cref="T:Microsoft.Office.Core.HTMLProjectItems" /> collection.</para>
<para>Use <b>HTMLProjectItems</b>(<paramref name="index" />), where <paramref name="index" /> is the name or index number of a project item, to return a single <b>HTMLProjectItem</b> object. Use the <see cref="P:Microsoft.Office.Core.HTMLProjectItem.Name" /> property to return the display name of the project item.</para>
<para>Use the <see cref="M:Microsoft.Office.Core.HTMLProjectItem.Open(Microsoft.Office.Core.MsoHTMLProjectOpen)" /> method to open a project item in source view or text view, and use the <see cref="P:Microsoft.Office.Core.HTMLProjectItem.IsOpen" /> property to determine whether the project item is currently open.</para>
<para>Use the <see cref="M:Microsoft.Office.Core.HTMLProjectItem.SaveCopyAs(System.String)" /> method to save the project item using a new file name.</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.HTMLProjectItem.Application" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Application As Object" />
<MemberSignature Language="F#" Value="member this.Application : obj" Usage="Microsoft.Office.Core.HTMLProjectItem.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.HTMLProjectItem.Creator" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Creator As Integer" />
<MemberSignature Language="F#" Value="member this.Creator : int" Usage="Microsoft.Office.Core.HTMLProjectItem.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 specified 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.HTMLProjectItem.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="IsOpen">
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsOpen { bool get(); };" />
<MemberSignature Language="C#" Value="public bool IsOpen { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsOpen" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.HTMLProjectItem.IsOpen" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsOpen As Boolean" />
<MemberSignature Language="F#" Value="member this.IsOpen : bool" Usage="Microsoft.Office.Core.HTMLProjectItem.IsOpen" />
<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.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Determines if the specified HTML project item is open in the Microsoft Script Editor.</summary>
<value>To be added.</value>
<remarks>
<para>This property returns <b>True</b> if the specified HTML project item is open in the Microsoft Script Editor; <b>False</b> if the item is not open.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="LoadFromFile">
<MemberSignature Language="C++ CLI" Value="public:
 void LoadFromFile(System::String ^ FileName);" />
<MemberSignature Language="C#" Value="public void LoadFromFile (string FileName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void LoadFromFile([in]string FileName) runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Core.HTMLProjectItem.LoadFromFile(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub LoadFromFile (FileName As String)" />
<MemberSignature Language="F#" Value="abstract member LoadFromFile : string -> unit" Usage="hTMLProjectItem.LoadFromFile FileName" />
<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="FileName" Type="System.String" />
</Parameters>
<Docs>
<param name="FileName">Required <b>String</b>. The fully qualified path of the text file that contains the text to be loaded.</param>
<summary>Updates the text in the Microsoft Script Editor with text from the specified file (on disk).</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ default { System::String ^ get(); };" />
<MemberSignature Language="C#" Value="public string this { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.HTMLProjectItem.Name" />
<MemberSignature Language="VB.NET" Value="Default Public ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="Microsoft.Office.Core.HTMLProjectItem.Name" />
<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>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the name of the specified object.</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.HTMLProjectItem.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="hTMLProjectItem.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(6)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(6)>]</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.HTMLProjectItem.Parent" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Parent As Object" />
<MemberSignature Language="F#" Value="member this.Parent : obj" Usage="Microsoft.Office.Core.HTMLProjectItem.Parent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(10)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(10)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(10)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(10)>]</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="SaveCopyAs">
<MemberSignature Language="C++ CLI" Value="public:
 void SaveCopyAs(System::String ^ FileName);" />
<MemberSignature Language="C#" Value="public void SaveCopyAs (string FileName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SaveCopyAs([in]string FileName) runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Core.HTMLProjectItem.SaveCopyAs(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub SaveCopyAs (FileName As String)" />
<MemberSignature Language="F#" Value="abstract member SaveCopyAs : string -> unit" Usage="hTMLProjectItem.SaveCopyAs FileName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(7)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(7)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="FileName" Type="System.String" />
</Parameters>
<Docs>
<param name="FileName">Required <b>String</b>. The fully qualified path of the file to which you want to save the HTML project item.</param>
<summary>Saves the specified HTML project item using a new file name.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Text">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Text { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="C#" Value="public string Text { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Text" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.HTMLProjectItem.Text" />
<MemberSignature Language="VB.NET" Value="Public Property Text As String" />
<MemberSignature Language="F#" Value="member this.Text : string with get, set" Usage="Microsoft.Office.Core.HTMLProjectItem.Text" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(8)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(8)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(8)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(8)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[set: System.Runtime.InteropServices.DispId(8)]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.InteropServices.DispId(8)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns or sets the HTML text in the HTML editor.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>