FractionalPageItemView
Topic Last Modified: 2006-06-14
The FractionalPageItemView element describes where the paged view starts and the maximum number of items returned in a FindItem request.
Schema Hierarchy
Syntax
<FractionalPageItemView MaxEntriesReturned="" Numerator="" Denominator=""/>
Type
FractionalPageViewType
Attributes and Elements
The following sections describe attributes, child elements, and parent elements.
Attributes
| Attribute | Description |
|---|---|
MaxEntriesReturned |
Identifies the maximum number of results to return in the FindItem response. This attribute is optional. If this attribute is not specified, the call will return all available items. |
Numerator |
Represents the numerator of the fractional offset from the start of the result set. This attribute is required. The numerator must be equal to or less than the denominator. This attribute must represent an integral value that is equal to or greater than zero. For more information, see Remarks later in this topic. |
Denominator |
Represents the denominator of the fractional offset from the start of the total number of items in the result set. This attribute is required. This attribute must represent an integral value that is greater than one. For more information, see Remarks later in this topic. |
Child Elements
None.
Parent Elements
| Element | Description |
|---|---|
Defines a request to find items in a mailbox. The following is the XPath expression to this element:
|
Remarks
The paged view offset from the start of the set of found items is described by a fraction. The fraction, which is defined by the Numerator and Denominator attributes, describes where the page of information starts. For example, if Numerator equals four and Denominator equals five, the page of returned information starts at an entry located four-fifths of the way in to the result set.
If the fraction evaluates to zero, that indicates the start of the results set. If the fraction evaluates to one, that indicates the end of the result set.
Note
The fraction represents the start point of page, not how many results in the result set will be returned.
The schema that describes this element is located in the EWS virtual directory of the computer that is running Microsoft Exchange Server 2007 that has the Client Access server role installed.
Example
The following example shows a FindItem request. The request returns items from the search results that start after the second third of all the items in the result set.
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/"
xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types">
<soap:Body>
<FindItem Traversal="Shallow" xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
<ItemShape>
<t:BaseShape>IdOnly</t:BaseShape>
<t:AdditionalProperties>
<t:FieldURI FieldURI="item:Subject"/>
</t:AdditionalProperties>
</ItemShape>
<FractionalPageItemView MaxEntriesReturned="12" Numerator="2" Denominator="3"/>
<GroupBy Order="Descending">
<t:FieldURI FieldURI="item:Importance"/>
<t:AggregateOn Aggregate="Maximum">
<t:FieldURI FieldURI="item:Subject"/>
</t:AggregateOn>
</GroupBy>
<ParentFolderIds>
<t:DistinguishedFolderId Id="inbox"/>
</ParentFolderIds>
</FindItem>
</soap:Body>
</soap:Envelope>
For example, if the result set contains nine items, the paged view will return up to 12 items, starting at the item found two-thirds of the way in to the result set. In this case, the page starts at the seventh item. The page will contain the seventh, eighth, and ninth items. If the numerator is set to zero, the page view will return all the items in the result set as long as the number is less than the MaxEntriesReturned attribute.
Element Information
Namespace |
https://schemas.microsoft.com/exchange/services/2006/messages |
Schema Name |
Messages schema |
Validation File |
Messages.xsd |
Can be Empty |
False |