Class ContentSearchOptions

Inheritance

object

ContentSearchOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Estrelica.Archer.Content

Assembly: Estrelica.Interfaces.dll

Syntax

public class ContentSearchOptions : ISearchOptions, ISearchDisplayFieldOptions

Fields

level

Declaration

public IArcherLevel level

Field Value

IArcherLevel

levelAlias

Declaration

public string levelAlias

Field Value

string

levelGuid

Declaration

public Guid? levelGuid

Field Value

Guid?

levelId

Declaration

public int? levelId

Field Value

int?

levelName

Declaration

public string levelName

Field Value

string

module

Declaration

public IArcherModule module

Field Value

IArcherModule

moduleAlias

Declaration

public string moduleAlias

Field Value

string

moduleGuid

Declaration

public Guid? moduleGuid

Field Value

Guid?

moduleId

Declaration

public int? moduleId

Field Value

int?

moduleName

Declaration

public string moduleName

Field Value

string

Properties

expectedIds

Declaration

public HashSet<int> expectedIds { get; set; }

Property Value

HashSet<int>

Implements

ISearchOptions.expectedIds

filterConditions

Declaration

public IEnumerable<XElement> filterConditions { get; set; }

Property Value

IEnumerable<XElement>

Implements

ISearchOptions.filterConditions

filterContainedDisplayFields

Declaration

public Func<IArcherField, IEnumerable<IArcherField>, IEnumerable<IArcherField>> filterContainedDisplayFields { get; set; }

Property Value

Func<IArcherField, IEnumerable<IArcherField>, IEnumerable<IArcherField>>

Implements

ISearchOptions.filterContainedDisplayFields

filterOperatorLogic

Declaration

public string filterOperatorLogic { get; set; }

Property Value

string

Implements

ISearchOptions.filterOperatorLogic

includeFieldCallback

Declaration

public Func<IArcherField, bool> includeFieldCallback { get; set; }

Property Value

Func<IArcherField, bool>

Implements

ISearchOptions.includeFieldCallback

includeFieldIds

Declaration

public IEnumerable<int> includeFieldIds { get; set; }

Property Value

IEnumerable<int>

Implements

ISearchOptions.includeFieldIds

includeXmlComments

Declaration

public bool includeXmlComments { get; set; }

Property Value

bool

Implements

ISearchOptions.includeXmlComments

modifiedSince

Declaration

public DateTime? modifiedSince { get; set; }

Property Value

DateTime?

Implements

ISearchOptions.modifiedSince

pageSizeOverride

Declaration

public int? pageSizeOverride { get; set; }

Property Value

int?

Implements

ISearchOptions.pageSizeOverride

recordCountCallback

Declaration

public Action<RecordCountType, int> recordCountCallback { get; set; }

Property Value

Action<RecordCountType, int>

Implements

ISearchDisplayFieldOptions.recordCountCallback

searchXmlPreview

Declaration

public Action<string> searchXmlPreview { get; set; }

Property Value

Action<string>

Implements

ISearchOptions.searchXmlPreview

sortFields

Declaration

public IEnumerable<SortField> sortFields { get; set; }

Property Value

IEnumerable<SortField>

Implements

ISearchOptions.sortFields

Methods

AddDisplayField(IArcherField)

Declaration

public ISearchOptions AddDisplayField(IArcherField displayField)

Parameters

IArcherField displayField

Returns

ISearchOptions

Implements

ISearchOptions.AddDisplayField(IArcherField)

AddDisplayField(int)

Declaration

public ISearchOptions AddDisplayField(int displayFieldId)

Parameters

int displayFieldId

Returns

ISearchOptions

Implements

ISearchOptions.AddDisplayField(int)

AddDisplayFields(params IArcherField[])

Declaration

public ISearchOptions AddDisplayFields(params IArcherField[] displayFields)

Parameters

IArcherField[] displayFields

Returns

ISearchOptions

Implements

ISearchOptions.AddDisplayFields(params IArcherField[])

AddDisplayFields(IEnumerable<IArcherField>)

Declaration

public ISearchOptions AddDisplayFields(IEnumerable<IArcherField> displayFields)

Parameters

IEnumerable<IArcherField> displayFields

Returns

ISearchOptions

Implements

ISearchOptions.AddDisplayFields(IEnumerable<IArcherField>)

AddDisplayFields(IEnumerable<int>)

Declaration

public ISearchOptions AddDisplayFields(IEnumerable<int> displayFieldIds)

Parameters

IEnumerable<int> displayFieldIds

Returns

ISearchOptions

Implements

ISearchOptions.AddDisplayFields(IEnumerable<int>)

AddDisplayFields(params int[])

Declaration

public ISearchOptions AddDisplayFields(params int[] displayFieldIds)

Parameters

int[] displayFieldIds

Returns

ISearchOptions

Implements

ISearchOptions.AddDisplayFields(params int[])

AddFilterCondition(XElement)

Declaration

public ISearchOptions AddFilterCondition(XElement filterCondition)

Parameters

XElement filterCondition

Returns

ISearchOptions

Implements

ISearchOptions.AddFilterCondition(XElement)

AddFilterConditions(IEnumerable<XElement>)

Declaration

public ISearchOptions AddFilterConditions(IEnumerable<XElement> filterConditions)

Parameters

IEnumerable<XElement> filterConditions

Returns

ISearchOptions

Implements

ISearchOptions.AddFilterConditions(IEnumerable<XElement>)

AddSortField(SortField)

Declaration

public ISearchOptions AddSortField(SortField sortField)

Parameters

SortField sortField

Returns

ISearchOptions

Implements

ISearchOptions.AddSortField(SortField)

AddSortField(IArcherField, SortType)

Declaration

public ISearchOptions AddSortField(IArcherField sortField, SortType sortType = SortType.Ascending)

Parameters

IArcherField sortField

SortType sortType

Returns

ISearchOptions

Implements

ISearchOptions.AddSortField(IArcherField, SortType)

AddSortField(int, SortType)

Declaration

public ISearchOptions AddSortField(int sortFieldId, SortType sortType = SortType.Ascending)

Parameters

int sortFieldId

SortType sortType

Returns

ISearchOptions

Implements

ISearchOptions.AddSortField(int, SortType)

ContainedDisplayFieldsFilter(Func<IArcherField, IEnumerable<IArcherField>, IEnumerable<IArcherField>>)

Declaration

public ISearchOptions ContainedDisplayFieldsFilter(Func<IArcherField, IEnumerable<IArcherField>, IEnumerable<IArcherField>> filterContainedDisplayFields)

Parameters

Func<IArcherField, IEnumerable<IArcherField>, IEnumerable<IArcherField>> filterContainedDisplayFields

Returns

ISearchOptions

Implements

ISearchOptions.ContainedDisplayFieldsFilter(Func<IArcherField, IEnumerable<IArcherField>, IEnumerable<IArcherField>>)

FilterOperatorLogic(string)

Declaration

public ISearchOptions FilterOperatorLogic(string filterOperatorLogic)

Parameters

string filterOperatorLogic

Returns

ISearchOptions

Implements

ISearchOptions.FilterOperatorLogic(string)

IncludeDisplayFieldCallback(Func<IArcherField, bool>)

Declaration

public ISearchOptions IncludeDisplayFieldCallback(Func<IArcherField, bool> includeFieldCallback)

Parameters

Func<IArcherField, bool> includeFieldCallback

Returns

ISearchOptions

Implements

ISearchOptions.IncludeDisplayFieldCallback(Func<IArcherField, bool>)

PageSize(int)

Declaration

public ISearchOptions PageSize(int pageSizeOverride)

Parameters

int pageSizeOverride

Returns

ISearchOptions

Implements

ISearchOptions.PageSize(int)

RecordCountCallback(Action<RecordCountType, int>)

Declaration

public ISearchOptions RecordCountCallback(Action<RecordCountType, int> recordCountCallback)

Parameters

Action<RecordCountType, int> recordCountCallback

Returns

ISearchOptions

Implements

ISearchOptions.RecordCountCallback(Action<RecordCountType, int>)

SearchXmlPreview(Action<string>, bool)

Declaration

public ISearchOptions SearchXmlPreview(Action<string> searchXmlPreview, bool includeXmlComments = false)

Parameters

Action<string> searchXmlPreview

bool includeXmlComments

Returns

ISearchOptions

Implements

ISearchOptions.SearchXmlPreview(Action<string>, bool)

Extension Methods

EnumHelper.In<TEnum>(TEnum, params TEnum[])

IEnumerableExtensions.ToEnumerable<T>(T)

StringExtensions.AssertNotNull<T>(T, string)

TypeExtensions.WithDispose<T, V>(T, Func<T, V>)

EnumHelper.CastNullable<TEnum>(object)

TypeExtensions.ConvertTo<V>(object)

TypeExtensions.TryConvert<V>(object, out V)