ExpandSegment Class

.NET Framework (current version)

Other Versions

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

Namespace: System.Data.Services
Assembly: System.Data.Services (in System.Data.Services.dll)

Inheritance Hierarchy

System::Object
System.Data.Services::ExpandSegment

Syntax

C++

public ref class ExpandSegment

Constructors

	Name	Description
	ExpandSegment(String^, Expression^)	Initializes an ExpandSegment object with the specified property name and a filtering expression, possibly null.

Properties

	Name	Description
	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.

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	PathHasFilter(IEnumerable<ExpandSegment^>^)	A Boolean value that indicates whether the path includes a filter option on target data.
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

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

Version Information

.NET Framework
Available since 3.5

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.