IndexedElement(XElement,IndexingHintAction) Method

A hint to create and use an index on the specified XML element. The hint has specified action.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Shared Function IndexedElement( _
   ByVal element As System.Xml.Linq.XElement, _
   ByVal action As IndexingHintAction _
) As XHint

public static XHint IndexedElement( 
   System.Xml.Linq.XElement element,
   IndexingHintAction action
)

Parameters

element: The element to apply the hint to.
action: The action specified by the hint.

Return Value

Formally, the hint returns the same value that it receives in the parameter. In fact, it is never executed, its role is purely declarative.

Remarks

Hints are used declaratively. They tell LiveLinq query optimizer to create and use an index on this element, if possible. After it is used for query optimization, before the query is executed, this hint is removed from the expression. See C1.LiveLinq.Hints for more details.

Example

var query =
    from c in customers
    where (string)c.Element("CustomerID").IndexedElement(IndexingHintAction.Mandatory) == "ALFKI"
    select c;

Requirements

Target Platforms: 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

Reference

XmlExtensions Class
XmlExtensions Members
Overload List