Class SliceField
Namespace: FastReport.Olap.Slice
Assembly: FastCube.Core.dll
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
public class SliceField
Inheritance
Constructors
SliceField(SliceFields, CubeField)
Creates a new instance.
public SliceField(SliceFields sliceFields, CubeField cubeField)
Parameters
sliceFields SliceFields
cubeField CubeField
Properties
AvailableUniqueValuesCount
Gets number of avaliable unique values.
public int AvailableUniqueValuesCount { get; }
Property Value
CanUseDateTimeSplit
Flag which indicates whether field can have date/time sub-fields
public bool CanUseDateTimeSplit { get; }
Property Value
Caption
Field caption
public string Caption { get; set; }
Property Value
Children
List of children
public List<SliceField> Children { get; }
Property Value
Collapsed
Gets or sets collapsed value.
public bool Collapsed { get; set; }
Property Value
CollapsedSubGroup
Gets or sets collapsed sub group value.
public bool CollapsedSubGroup { get; set; }
Property Value
CubeField
Reference to CubeField
public CubeField CubeField { get; }
Property Value
CurrentValue
Current field value for script handlers
public object CurrentValue { get; }
Property Value
DataType
Field data type
public DataType DataType { get; }
Property Value
DateTimeSplitsCount
Number of date/time sub-fields
public int DateTimeSplitsCount { get; }
Property Value
DeniedUniqueValuesCount
Gets number of denied unique values.
public int DeniedUniqueValuesCount { get; }
Property Value
DisplayFormat
Gets or sets diaplay format.
public FormatBase DisplayFormat { get; set; }
Property Value
ExistsOtherGroup
Gets or sets indicator that is exists other group.
public bool ExistsOtherGroup { get; }
Property Value
GroupsCount
Gets or sets number of groups.
public int GroupsCount { get; }
Property Value
GroupsManager
Gets reference to groups manager.
public GroupsManager GroupsManager { get; }
Property Value
HasGroups
Gets an indicator that field has groups.
public bool HasGroups { get; }
Property Value
Height
Height of field (for grid)
public int Height { get; set; }
Property Value
HeightSubGroup
Height of sub group (for grid)
public int HeightSubGroup { get; set; }
Property Value
Index
Field index
public int Index { get; }
Property Value
Name
Field name
public string Name { get; }
Property Value
Parent
Reference to parent field
public SliceField Parent { get; }
Property Value
PopupShowAvailable
Flag to show only available (not filtered by neighbour fields) unique values (for grid)
public bool PopupShowAvailable { get; set; }
Property Value
PopupWidth
Width of popup window (for grid)
public int PopupWidth { get; set; }
Property Value
Slice
Reference to Slice (readonly)
public Slice Slice { get; }
Property Value
UVFilterType
Gets or sets filter type of unique values.
public UniqueValuesFilterType UVFilterType { get; set; }
Property Value
UniqueValueFilterActive
Gets indicator that unique value filter is active.
public bool UniqueValueFilterActive { get; }
Property Value
UniqueValueSingleIndex
Gets or sets single index of unique value.
public int UniqueValueSingleIndex { get; set; }
Property Value
Width
Width of field (for grid)
public int Width { get; set; }
Property Value
WidthSubGroup
Width of sub group (for grid)
public int WidthSubGroup { get; set; }
Property Value
Methods
AddDateTimeSplit(DateTimePart)
Adds date/time sub-field
public bool AddDateTimeSplit(DateTimePart dateTimePart)
Parameters
dateTimePart DateTimePart
Part to add
Returns
True - success
BeginUpdateField()
Geting update field.
public void BeginUpdateField()
BuildUniqueValuesTree(bool)
Builds Tree with unique ID in nodes Mostly method for internal use in grids
public Tree BuildUniqueValuesTree(bool showAvailable)
Parameters
showAvailable bool
Flag to show only available uniques (ignore uniques which filtered by other dimension filters)
Returns
Tree
CanCreateDateTimeSplit(DateTimePart)
Determines whether it is possible to create particular date/time sub-field
public bool CanCreateDateTimeSplit(DateTimePart dateTimePart)
Parameters
dateTimePart DateTimePart
date/time part
Returns
True if sub-field can be created
EndUpdateField()
Ends update field.
public void EndUpdateField()
GetAllowedUniqueValue(int)
Gets allowed unique values by value id.
public bool GetAllowedUniqueValue(int valueId)
Parameters
valueId int
Returns
GetAvailableUniqueValue(int)
Gets available unique value by valuee id.
public bool GetAvailableUniqueValue(int valueId)
Parameters
valueId int
Returns
GetCountValuesInGroup(int)
Gets number of values in group by group id.
public int GetCountValuesInGroup(int groupId)
Parameters
groupId int
Returns
GetGroupIdByOrder(int)
Gets group id by order/
public int GetGroupIdByOrder(int index)
Parameters
index int
Returns
GetGroupName(int)
Gets group name
public string GetGroupName(int groupId)
Parameters
groupId int
Returns
GetGroupNameByOrder(int)
Gets group name by order (by index).
public string GetGroupNameByOrder(int index)
Parameters
index int
Returns
GetGroupedUniqueValueCaption(int, int)
Gets grouped unique value caption.
public string GetGroupedUniqueValueCaption(int groupId, int indexInGroup)
Parameters
groupId int
indexInGroup int
Returns
GetUnGroupedUniqueValueCaption(int)
Gets ungrouped unique value caption.
public string GetUnGroupedUniqueValueCaption(int indexInUnGroup)
Parameters
indexInUnGroup int
Returns
GetUnGroupedUniqueValueIdByOrder(int)
Gets ungrouped unique value id by order (by index).
public int GetUnGroupedUniqueValueIdByOrder(int index)
Parameters
index int
Returns
GetUnGroupedUniqueValuesCount()
Gets number of ungrouped unique values.
public int GetUnGroupedUniqueValuesCount()
Returns
GetUniqueValue(int)
Get value of particular unique.
public object GetUniqueValue(int ValueId)
Parameters
ValueId int
unique value ID
Returns
Unique value
GetUniqueValueCaption(int)
Get caption of particular unique.
public string GetUniqueValueCaption(int ValueId)
Parameters
ValueId int
unique value ID
Returns
String representation of unique value
GetUniqueValueFromRecord(int)
Get value from record index
public object GetUniqueValueFromRecord(int recordIndex)
Parameters
recordIndex int
record index of source data
Returns
Unique value
GetUniqueValueIdAndVariantFromRecord(int, out object)
Get both unique ID and value from record index
public int GetUniqueValueIdAndVariantFromRecord(int recordIndex, out object value)
Parameters
recordIndex int
record index of source data
value object
variable to save value
Returns
unique ID
GetUniqueValueIdFromRecord(int)
Get unique ID from record index
public int GetUniqueValueIdFromRecord(int recordIndex)
Parameters
recordIndex int
record index of source data
Returns
unique ID
GetUniqueValueIdInGroupByOrder(int, int)
Gets unique value id in group by order (by group id and index).
public int GetUniqueValueIdInGroupByOrder(int groupId, int index)
Parameters
groupId int
index int
Returns
GetUniqueValuesCount()
Count of unique values for field
public int GetUniqueValuesCount()
Returns
Count
GetUniqueValuesFilterStateOfGroup(int)
Gets state of group.
public CheckState GetUniqueValuesFilterStateOfGroup(int groupId)
Parameters
groupId int
Returns
HaveDateTimeSplit(DateTimePart)
Searches for date/time sub-field
public bool HaveDateTimeSplit(DateTimePart dateTimePart)
Parameters
dateTimePart DateTimePart
Part to search for
Returns
True if found
InverseFilter()
Inverses filter.
public void InverseFilter()
Load(XmlItem, int)
Load from XML item
public void Load(XmlItem item, int version)
Parameters
item XmlItem
Item to load from
version int
Format version
RemoveDateTimeSplit(DateTimePart)
Removes date/time sub-field
public bool RemoveDateTimeSplit(DateTimePart dateTimePart)
Parameters
dateTimePart DateTimePart
Part to remove
Returns
True - success
RollBackField()
Rolls back field.
public void RollBackField()
Save(XmlItem)
Save to XML item
public void Save(XmlItem item)
Parameters
item XmlItem
XML item
SetAllAllowed()
Sets all allowed.
public void SetAllAllowed()
SetAllDenied()
Sets all denied.
public void SetAllDenied()
SetAllowedUniqueValue(int, bool)
Sets allowed unique value.
public void SetAllowedUniqueValue(int valueId, bool value)
Parameters
valueId int
value bool
SetGroupName(int, string)
Sets group name.
public void SetGroupName(int groupId, string groupName)
Parameters
groupId int
groupName string
SetGroupNameByOrder(int, string)
Sets group name by order (by index).
public void SetGroupNameByOrder(int index, string groupName)
Parameters
index int
groupName string
SetRangeFilter(Ranges)
Sets range filter.
public void SetRangeFilter(Ranges ranges)
Parameters
ranges Ranges
SetUniqueValuesFilterStateOfGroup(int, CheckState)
Sets state of group.
public void SetUniqueValuesFilterStateOfGroup(int groupId, CheckState checkState)
Parameters
groupId int
checkState CheckState
SetUniqueValuesGroupSingleIndex(int)
Sets single index.
public void SetUniqueValuesGroupSingleIndex(int groupId)
Parameters
groupId int