Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

IncludeAttribute Class

WCF RIA Services

[WCF RIA Services Version 1 Service Pack 2 is compatible with either .NET framework 4 or .NET Framework 4.5, and with either Silverlight 4 or Silverlight 5.]

Specifies that the association should be part of any code-generated client entities.

System.Object
  System.Attribute
    System.ServiceModel.DomainServices.Server.IncludeAttribute

Namespace:  System.ServiceModel.DomainServices.Server
Assembly:  System.ServiceModel.DomainServices.Server (in System.ServiceModel.DomainServices.Server.dll)
C#
C++
F#
JScript
VB
Copy 
[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field, AllowMultiple = true, 
	Inherited = true)]
public sealed class IncludeAttribute : Attribute

The IncludeAttribute type exposes the following members.

  Name Description
Public method IncludeAttribute() Initializes a new instance of the IncludeAttribute class.
Public method IncludeAttribute(String, String) Initializes a new instance of the IncludeAttribute class with the specified member projection.
Top
  Name Description
Public property IsProjection Gets a value that indicates whether this attribute specifies a member projection.
Public property MemberName Gets the name of the destination member for the projection.
Public property Path Gets the member projection path.
Public property TypeId Gets a unique identifier for this attribute. (Overrides Attribute.TypeId.)
Top
  Name Description
Public method Equals (Inherited from Attribute.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Attribute.)
Public method GetType (Inherited from Object.)
Public method IsDefaultAttribute (Inherited from Attribute.)
Public method Match (Inherited from Attribute.)
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)
Top
  Name Description
Explicit interface implemetation Private method _Attribute.GetIDsOfNames (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfo (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.GetTypeInfoCount (Inherited from Attribute.)
Explicit interface implemetation Private method _Attribute.Invoke (Inherited from Attribute.)
Top

When applied to an entity association, this attribute specifies that the association should be part of any code-generated client entities, and that any related entities should be included when serializing results to the client. In the query method, you must ensure that the associated entities are actually loaded by using the Include method on the query. This attribute can also be used to specify member projections.

The following example shows the IncludeAttribute attribute applied to a member that is part of a hierarchy.

C#
VB
Copy 
[MetadataTypeAttribute(typeof(SalesOrderHeader.SalesOrderHeaderMetadata))]
public partial class SalesOrderHeader
{
    internal sealed class SalesOrderHeaderMetadata
    {
        private SalesOrderHeaderMetadata()
        {
        }

        [Include]
        [Composition]
        public EntitySet<SalesOrderDetail> SalesOrderDetails;

    }
}

The following example shows how to include the results in the query.

C#
VB
Copy 
public IQueryable<SalesOrderHeader> GetSalesOrders()
{
    return this.ObjectContext.SalesOrderHeaders.Include("SalesOrderDetails");
}
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)