Class SliceField

Raw field of slice - can be used as base for Dimensions and Measures. Slice fields comes from Cube and in fact are wrappers around them

Inheritance

System.Object

SliceField

Namespace: FastReport.Olap.Slice

Assembly: FastReport.Olap.dll

Syntax

public class SliceField

Constructors

SliceField(SliceFields, CubeField)

Declaration

public SliceField(SliceFields sliceFields, CubeField cubeField)

Parameters

Type	Name	Description
SliceFields	sliceFields
CubeField	cubeField

Properties

AvailableUniqueValuesCount

Declaration

public int AvailableUniqueValuesCount { get; }

Property Value

Type	Description
System.Int32

CanUseDateTimeSplit

Flag which indicates whether field can have date/time sub-fields

Declaration

public bool CanUseDateTimeSplit { get; }

Property Value

Type	Description
System.Boolean

Caption

Field caption

Declaration

public string Caption { get; set; }

Property Value

Type	Description
System.String

Children

List of children

Declaration

public List<SliceField> Children { get; }

Property Value

Type	Description
System.Collections.Generic.List<SliceField>

Collapsed

todo:

Declaration

public bool Collapsed { get; set; }

Property Value

Type	Description
System.Boolean

CollapsedSubGroup

todo:

Declaration

public bool CollapsedSubGroup { get; set; }

Property Value

Type	Description
System.Boolean

CubeField

Reference to CubeField

Declaration

public CubeField CubeField { get; }

Property Value

Type	Description
CubeField

CurrentValue

Current field value for script handlers

Declaration

public Variant CurrentValue { get; }

Property Value

Type	Description
Variant

DataType

Field data type

Declaration

public DataType DataType { get; }

Property Value

Type	Description
DataType

DateTimeSplitsCount

Number of date/time sub-fields

Declaration

public int DateTimeSplitsCount { get; }

Property Value

Type	Description
System.Int32

DeniedUniqueValuesCount

Declaration

public int DeniedUniqueValuesCount { get; }

Property Value

Type	Description
System.Int32

DisplayFormat

Declaration

public FormatBase DisplayFormat { get; set; }

Property Value

Type	Description
FormatBase

ExistsOtherGroup

Declaration

public bool ExistsOtherGroup { get; }

Property Value

Type	Description
System.Boolean

GroupsCount

Declaration

public int GroupsCount { get; }

Property Value

Type	Description
System.Int32

GroupsManager

Declaration

public GroupsManager GroupsManager { get; }

Property Value

Type	Description
GroupsManager

HasGroups

Declaration

public bool HasGroups { get; }

Property Value

Type	Description
System.Boolean

Height

Height of field (for grid)

Declaration

public int Height { get; set; }

Property Value

Type	Description
System.Int32

HeightSubGroup

Height of sub group (for grid)

Declaration

public int HeightSubGroup { get; set; }

Property Value

Type	Description
System.Int32

Index

Field index

Declaration

public int Index { get; }

Property Value

Type	Description
System.Int32

Name

Field name

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

Parent

Reference to parent field

Declaration

public SliceField Parent { get; }

Property Value

Type	Description
SliceField

PopupShowAvailable

Flag to show only available (not filtered by neighbour fields) unique values (for grid)

Declaration

public bool PopupShowAvailable { get; set; }

Property Value

Type	Description
System.Boolean

PopupWidth

Width of popup window (for grid)

Declaration

public int PopupWidth { get; set; }

Property Value

Type	Description
System.Int32

Slice

Reference to Slice (readonly)

Declaration

public Slice Slice { get; }

Property Value

Type	Description
Slice

UniqueValueFilterActive

Declaration

public bool UniqueValueFilterActive { get; }

Property Value

Type	Description
System.Boolean

UniqueValueSingleIndex

Declaration

public int UniqueValueSingleIndex { get; set; }

Property Value

Type	Description
System.Int32

UVFilterType

Declaration

public UniqueValuesFilterType UVFilterType { get; set; }

Property Value

Type	Description
UniqueValuesFilterType

Width

Width of field (for grid)

Declaration

public int Width { get; set; }

Property Value

Type	Description
System.Int32

WidthSubGroup

Width of sub group (for grid)

Declaration

public int WidthSubGroup { get; set; }

Property Value

Type	Description
System.Int32

Methods

AddDateTimeSplit(DateTimePart)

Adds date/time sub-field

Declaration

public bool AddDateTimeSplit(DateTimePart dateTimePart)

Parameters

Type	Name	Description
DateTimePart	dateTimePart	Part to add

Returns

Type	Description
System.Boolean	True - success

BeginUpdateField()

Declaration

public void BeginUpdateField()

BuildUniqueValuesTree(Boolean)

Builds Tree with unique ID in nodes Mostly method for internal use in grids

Declaration

public Tree BuildUniqueValuesTree(bool showAvailable)

Parameters

Type	Name	Description
System.Boolean	showAvailable	Flag to show only available uniques (ignore uniques which filtered by other dimension filters)

Returns

Type	Description
Tree	Tree

CanCreateDateTimeSplit(DateTimePart)

Determines whether it is possible to create particular date/time sub-field

Declaration

public bool CanCreateDateTimeSplit(DateTimePart dateTimePart)

Parameters

Type	Name	Description
DateTimePart	dateTimePart	date/time part

Returns

Type	Description
System.Boolean	True if sub-field can be created

EndUpdateField()

Declaration

public void EndUpdateField()

GetAllowedUniqueValue(Int32)

Declaration

public bool GetAllowedUniqueValue(int valueId)

Parameters

Type	Name	Description
System.Int32	valueId

Returns

Type	Description
System.Boolean

GetAvailableUniqueValue(Int32)

Declaration

public bool GetAvailableUniqueValue(int valueId)

Parameters

Type	Name	Description
System.Int32	valueId

Returns

Type	Description
System.Boolean

GetCountValuesInGroup(Int32)

Declaration

public int GetCountValuesInGroup(int groupId)

Parameters

Type	Name	Description
System.Int32	groupId

Returns

Type	Description
System.Int32

GetGroupedUniqueValueCaption(Int32, Int32)

Declaration

public string GetGroupedUniqueValueCaption(int groupId, int indexInGroup)

Parameters

Type	Name	Description
System.Int32	groupId
System.Int32	indexInGroup

Returns

Type	Description
System.String

GetGroupIdByOrder(Int32)

Declaration

public int GetGroupIdByOrder(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Int32

GetGroupName(Int32)

Declaration

public string GetGroupName(int groupId)

Parameters

Type	Name	Description
System.Int32	groupId

Returns

Type	Description
System.String

GetGroupNameByOrder(Int32)

Declaration

public string GetGroupNameByOrder(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.String

GetUnGroupedUniqueValueCaption(Int32)

Declaration

public string GetUnGroupedUniqueValueCaption(int indexInUnGroup)

Parameters

Type	Name	Description
System.Int32	indexInUnGroup

Returns

Type	Description
System.String

GetUnGroupedUniqueValueIdByOrder(Int32)

Declaration

public int GetUnGroupedUniqueValueIdByOrder(int index)

Parameters

Type	Name	Description
System.Int32	index

Returns

Type	Description
System.Int32

GetUnGroupedUniqueValuesCount()

Declaration

public int GetUnGroupedUniqueValuesCount()

Returns

Type	Description
System.Int32

GetUniqueValue(Int32)

Get value of particular unique

Declaration

public Variant GetUniqueValue(int ValueId)

Parameters

Type	Name	Description
System.Int32	ValueId	unique value ID

Returns

Type	Description
Variant	Unique value

GetUniqueValueCaption(Int32)

Get caption of particular unique

Declaration

public string GetUniqueValueCaption(int ValueId)

Parameters

Type	Name	Description
System.Int32	ValueId	unique value ID

Returns

Type	Description
System.String	String representation of unique value

GetUniqueValueFromRecord(Int32)

Get value from record index

Declaration

public Variant GetUniqueValueFromRecord(int recordIndex)

Parameters

Type	Name	Description
System.Int32	recordIndex	record index of source data

Returns

Type	Description
Variant	Unique value

GetUniqueValueIdAndVariantFromRecord(Int32, out Variant)

Get both unique ID and value from record index

Declaration

public int GetUniqueValueIdAndVariantFromRecord(int recordIndex, out Variant value)

Parameters

Type	Name	Description
System.Int32	recordIndex	record index of source data
Variant	value	variable to save value

Returns

Type	Description
System.Int32	unique ID

GetUniqueValueIdFromRecord(Int32)

Get unique ID from record index

Declaration

public int GetUniqueValueIdFromRecord(int recordIndex)

Parameters

Type	Name	Description
System.Int32	recordIndex	record index of source data

Returns

Type	Description
System.Int32	unique ID

GetUniqueValueIdInGroupByOrder(Int32, Int32)

Declaration

public int GetUniqueValueIdInGroupByOrder(int groupId, int index)

Parameters

Type	Name	Description
System.Int32	groupId
System.Int32	index

Returns

Type	Description
System.Int32

GetUniqueValuesCount()

Count of unique values for field

Declaration

public int GetUniqueValuesCount()

Returns

Type	Description
System.Int32	Count

GetUniqueValuesFilterStateOfGroup(Int32)

Declaration

public CheckState GetUniqueValuesFilterStateOfGroup(int groupId)

Parameters

Type	Name	Description
System.Int32	groupId

Returns

Type	Description
CheckState

HaveDateTimeSplit(DateTimePart)

Searches for date/time sub-field

Declaration

public bool HaveDateTimeSplit(DateTimePart dateTimePart)

Parameters

Type	Name	Description
DateTimePart	dateTimePart	Part to search for

Returns

Type	Description
System.Boolean	True if found

InverseFilter()

Declaration

public void InverseFilter()

Load(XmlItem, Int32)

Load from XML item

Declaration

public void Load(XmlItem item, int version)

Parameters

Type	Name	Description
XmlItem	item	Item to load from
System.Int32	version	Format version

RemoveDateTimeSplit(DateTimePart)

Removes date/time sub-field

Declaration

public bool RemoveDateTimeSplit(DateTimePart dateTimePart)

Parameters

Type	Name	Description
DateTimePart	dateTimePart	Part to remove

Returns

Type	Description
System.Boolean	True - success

RollBackField()

Declaration

public void RollBackField()

Save(XmlItem)

Save to XML item

Declaration

public void Save(XmlItem item)

Parameters

Type	Name	Description
XmlItem	item	XML item

SetAllAllowed()

Declaration

public void SetAllAllowed()

SetAllDenied()

Declaration

public void SetAllDenied()

SetAllowedUniqueValue(Int32, Boolean)

Declaration

public void SetAllowedUniqueValue(int valueId, bool value)

Parameters

Type	Name	Description
System.Int32	valueId
System.Boolean	value

SetGroupName(Int32, String)

Declaration

public void SetGroupName(int groupId, string groupName)

Parameters

Type	Name	Description
System.Int32	groupId
System.String	groupName

SetGroupNameByOrder(Int32, String)

Declaration

public void SetGroupNameByOrder(int index, string groupName)

Parameters

Type	Name	Description
System.Int32	index
System.String	groupName

SetRangeFilter(Ranges)

Declaration

public void SetRangeFilter(Ranges ranges)

Parameters

Type	Name	Description
Ranges	ranges

SetUniqueValuesFilterStateOfGroup(Int32, CheckState)

Declaration

public void SetUniqueValuesFilterStateOfGroup(int groupId, CheckState checkState)

Parameters

Type	Name	Description
System.Int32	groupId
CheckState	checkState

SetUniqueValuesGroupSingleIndex(Int32)

Declaration

public void SetUniqueValuesGroupSingleIndex(int groupId)

Parameters

Type	Name	Description
System.Int32	groupId