Skip to content

Commit c520f12

Browse files
committed
Removed erroneous paging information
1 parent 0fa3b7c commit c520f12

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed
Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# LoadOption object (JavaScript API for Word)
22

3-
An object that specifies paging information and the properties to load when context.sync() is called.
3+
An object that specifies paging information and the properties to load when context.sync() is called.
44

55
_Applies to: Word 2016, Word for iPad, Word for Mac_
66

@@ -9,34 +9,34 @@ _Applies to: Word 2016, Word for iPad, Word for Mac_
99
|:---------------|:--------|:----------|
1010
|select|object|Contains a comma delimited list or an array of parameter/relationship names. Optional.|
1111
|expand|object|Contains a comma delimited list or an array of relationship names. Optional.|
12-
|top|int| Specifies the maximum number of collection items that can be included in the result. Optional.|
13-
|skip|int|Specify the number of items in the collection that are to be skipped and not included in the result. If `top` is specified, the result set will start after skipping the specified number of items. Optional.|
12+
|top|int| Specifies the maximum number of collection items that can be included in the result. Optional. You can only use this option when you use the object notation option.|
13+
|skip|int|Specify the number of items in the collection that are to be skipped and not included in the result. If `top` is specified, the result set will start after skipping the specified number of items. Optional. You can only use this option when you use the object notation option.|
1414

1515
## More information
1616

1717
The preferred method for specifying the properties and paging information is by using a string literal. The first two examples show the preferred way to request the text and font size properties for paragraphs in a paragraph collection:
1818

19-
<code>context.load(paragraphs, 'text, font/size, top: 50, skip: 0');</code>
19+
<code>context.load(paragraphs, 'text, font/size');</code>
2020

21-
<code>paragraphs.load('text, font/size, top: 50, skip: 0');</code>
21+
<code>paragraphs.load('text, font/size');</code>
2222

23-
Here is the equivalent using object notation:
23+
Here is a similar example using object notation (includes paging):
2424

2525
<code>context.load(paragraphs, {select: 'text, font/size',
2626
expand: 'font',
2727
top: 50,
2828
skip: 0});</code>
29-
29+
3030
<code>paragraphs.load({select: 'text, font/size',
3131
expand: 'font',
3232
top: 50,
3333
skip: 0});</code>
3434

35-
Note that if we don't specify the specific properties on the font object in the select statement, the expand statement by itself would indicate that all of the font properties are loaded.
35+
Note that if we don't specify the specific properties on the font object in the select statement, the expand statement by itself would indicate that all of the font properties are loaded.
3636

3737
## Examples
3838

39-
This example shows how to get the top 50 paragraphs in the Word document along with their text and font size properties.
39+
This example shows how to get the paragraphs in the Word document along with their text and font size properties.
4040

4141
```js
4242
// Run a batch operation against the Word object model.
@@ -45,15 +45,15 @@ This example shows how to get the top 50 paragraphs in the Word document along w
4545
// Create a proxy object for the paragraphs collection.
4646
var paragraphs = context.document.body.paragraphs;
4747

48-
// Queue a commmand to load the text and font properties for the top 50 paragraphs.
48+
// Queue a commmand to load the text and font properties.
4949
// It is best practice to always specify the property set. Otherwise, all properties are
50-
// returned in on the object.
51-
context.load(paragraphs, 'text, font/size, top: 50, skip: 0');
50+
// returned in on the object.
51+
context.load(paragraphs, 'text, font/size');
5252

53-
// Synchronize the document state by executing the queued commands,
53+
// Synchronize the document state by executing the queued commands,
5454
// and return a promise to indicate task completion.
5555
return context.sync().then(function () {
56-
56+
5757
// Insert code that works with the paragraphs loaded by context.load().
5858

5959
})
@@ -68,4 +68,4 @@ This example shows how to get the top 50 paragraphs in the Word document along w
6868
6969
## Support details
7070
71-
Use the [requirement set](https://msdn.microsoft.com/EN-US/library/office/mt590206.aspx) in run time checks to make sure your application is supported by the host version of Word. For more information about Office host application and server requirements, see [Requirements for running Office Add-ins](https://msdn.microsoft.com/EN-US/library/office/dn833104.aspx).
71+
Use the [requirement set](https://msdn.microsoft.com/EN-US/library/office/mt590206.aspx) in run time checks to make sure your application is supported by the host version of Word. For more information about Office host application and server requirements, see [Requirements for running Office Add-ins](https://msdn.microsoft.com/EN-US/library/office/dn833104.aspx).

0 commit comments

Comments
 (0)