Class ContextItemFilter

Represents a filter for retrieving context items.

Inheritance

object

ContextItemFilter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DataWeb.Structure

Assembly: DataWeb.Core.dll

Syntax

public sealed class ContextItemFilter

Properties

Count

Gets or sets the count of items to retrieve.

Declaration

public int Count { get; set; }

Property Value

Type	Description
int

Culture

Gets or sets the culture used to filter the context item.

Declaration

public string Culture { get; set; }

Property Value

Type	Description
string

ElementSections

Gets or sets the sections containing the element for the context item.

Declaration

public IEnumerable<Section> ElementSections { get; set; }

Property Value

Type	Description
IEnumerable<Section>

IsDataFieldExcluded

Gets or sets a value indicating whether data fields are excluded.

Declaration

public bool IsDataFieldExcluded { get; set; }

Property Value

Type	Description
bool

IsOrderByPosition

Gets or sets a value indicating whether to order by position.

Declaration

public bool IsOrderByPosition { get; set; }

Property Value

Type	Description
bool

IsPagination

Gets or sets a value indicating whether pagination is used.

Declaration

public bool IsPagination { get; set; }

Property Value

Type	Description
bool

IsUserDataFields

Gets or sets a value indicating whether to retrieve user data fields.

Declaration

public bool IsUserDataFields { get; set; }

Property Value

Type	Description
bool

ItemIdMasters

Gets or sets a list of item Ids to retrieve.

Declaration

public List<string> ItemIdMasters { get; set; }

Property Value

Type	Description
List<string>

Navigation

Gets or sets the navigation object representing the path to the context item.

Declaration

public Navigation Navigation { get; set; }

Property Value

Type	Description
Navigation

OrderDataFields

Gets or sets the data fields used to order the context item.

Declaration

public List<ContextItemFilter.OrderDataField> OrderDataFields { get; set; }

Property Value

Type	Description
List<ContextItemFilter.OrderDataField>

PageIndex

Gets or sets the page index used for pagination.

Declaration

public long PageIndex { get; set; }

Property Value

Type	Description
long

PageSize

Gets or sets the page size used for pagination.

Declaration

public int PageSize { get; set; }

Property Value

Type	Description
int

PermissionSet

Gets or sets the permission set used to filter the context item.

Declaration

public PermissionSet PermissionSet { get; set; }

Property Value

Type	Description
PermissionSet

PublishMode

Gets or sets the publish mode used to filter the context item.

Declaration

public PublishMode? PublishMode { get; set; }

Property Value

Type	Description
PublishMode?

SearchDataFields

Gets or sets the data fields used to search for the context item.

Declaration

public List<ContextItemFilter.FilterDataField> SearchDataFields { get; set; }

Property Value

Type	Description
List<ContextItemFilter.FilterDataField>

SearchLabel

Gets or sets the label used to search for the context item.

Declaration

public string SearchLabel { get; set; }

Property Value

Type	Description
string

Status

Gets or sets the status used to filter the context item.

Declaration

public ItemStatus? Status { get; set; }

Property Value

Type	Description
ItemStatus?

View

Gets or sets the view used to retrieve the context item.

Declaration

public View View { get; set; }

Property Value

Type	Description
View