This topic has not yet been rated - Rate this topic

ExpandSegment Class

The segment of a query that indicates whether data should be returned inline instead of as deferred content.

System.Object
  System.Data.Services.ExpandSegment

Namespace:  System.Data.Services
Assembly:  System.Data.Services (in System.Data.Services.dll)
public class ExpandSegment

The ExpandSegment type exposes the following members.

  Name Description
Public method ExpandSegment Initializes an ExpandSegment object with the specified property name and a filtering expression, possibly null.
Top
  Name Description
Public property ExpandedProperty Gets the property to be expanded.
Public property Filter The filter option in the query to which the expand segment applies.
Public property HasFilter A Boolean value that indicates whether the expand statement is used with a filter expression.
Public property MaxResultsExpected Gets the maximum number of results expected.
Public property Name The name of the property to be expanded.
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Static member PathHasFilter A Boolean value that indicates whether the path includes a filter option on target data.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

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.

The following URI expands the OrderLines associated with each Order returned by the query.

http://host/service.svc/Orders?$expand=OrderLines

.NET Framework

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ