ExpandSegment Class
The segment of a query that indicates whether data should be returned inline instead of as deferred content.
Inheritance Hierarchy
System.Object
System.Data.Services.ExpandSegment
Namespace: System.Data.Services
Assembly: Microsoft.Data.Services (in Microsoft.Data.Services.dll)
Syntax
'Declaration
Public Class ExpandSegment
'Usage
Dim instance As ExpandSegment
public class ExpandSegment
public ref class ExpandSegment
type ExpandSegment = class end
public class ExpandSegment
The ExpandSegment type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
ExpandSegment | Initializes an ExpandSegment object with the specified property name and a filtering expression, possibly null. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
ExpandedProperty | Gets the property to be expanded. |
|
Filter | The filter option in the query to which the expand segment applies. |
|
HasFilter | A Boolean value that indicates whether the expand statement is used with a filter expression. |
|
MaxResultsExpected | Gets the maximum number of results expected. |
|
Name | The name of the property to be expanded. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
.gif "Static member") |
PathHasFilter | A Boolean value that indicates whether the path includes a filter option on target data. |
|
ToString | (Inherited from Object.) |
Top
Remarks
An $expandclause indicates that each $expanditem should be fully expanded. For example, the value OrderLines.Product.Image with $expand causes OrderLines, the Product of each element in OrderLines, and the Image of the Product of each element in OrderLines to be expanded.
The left-most property in an $expand clause must be a property on the entity type within the entity set identified by the last path segment in the request URI.
Redundant expand clause rules are acceptable and ignored.
Examples
The following URI expands the OrderLines associated with each Order returned by the query.
http://host/service.svc/Orders?$expand=OrderLines
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.