| Package | stimulsoft.report.components.bands |
| Class | public class StiHierarchicalBand |
| Inheritance | StiHierarchicalBand  StiDataBand StiDynamicBand StiBand StiContainer StiComponent StiBase StiService StiObject Object |
| Property | Defined By | ||
|---|---|---|---|
 | afterPrintEvent : StiAfterPrintEvent Occurs after the component printing. | StiComponent | |
| alias : String Gets or sets a text that will be shown instead of a component name. | StiComponent | |
| allowDelete : Boolean [read-only] Gets a value which indicates whether deleting of the components is allowed. | StiComponent | |
| bandInfoV2 : StiBandInfoV2 [read-only] | StiBand | |
| beforePrintEvent : StiBeforePrintEvent Occurs before printing of the component. | StiComponent | |
| beginRenderEvent : StiBeginRenderEvent Occurs when when a band begins to render. | StiDataBand | |
| blocked : Boolean
Internal use only. | StiContainer | |
| bookmark : StiBookmarkExpression Gets or sets the expression to fill a component bookmark. | StiComponent | |
| bookmarkValue : String Gets or sets the component bookmark. | StiComponent | |
| border : StiBorder Gets or sets frame of the component. | StiContainer | |
| bottom : Number [read-only] Gets bottom position of a component. | StiComponent | |
| breakIfLessThan : Number
Gets or sets value which indicates how much free space is on a page (in per cent) should be reserved for formation of a new page or a new column. | StiDynamicBand | |
| brush : StiBrush Gets or sets a brush to fill a component. | StiContainer | |
| businessObject : StiBusinessObject [read-only] Get business object that is used for getting data. | StiDataBand | |
| businessObjectGuid : String Gets or sets guid of the Business Object. | StiDataBand | |
| calcInvisible : Boolean Gets or sets value which indicates that, when aggregate functions calculation, it is nesessary to take into consideration invisible data bands. | StiDataBand | |
| canBreak : Boolean [override] Gets or sets value which indicates whether the component can or cannot break its contents on several pages. | StiDynamicBand | |
| canGrow : Boolean [override] Gets or sets value indicates that this object can grow. | StiBand | |
| canShrink : Boolean Gets or sets value which indicates that this object can shrink. | StiComponent | |
| clickEvent : StiClickEvent Occurs when user clicks on the component in the window of viewer. | StiComponent | |
| clientRectangle : StiRectangle Gets or sets the client area of a component. | StiComponent | |
| collapsed : StiCollapsedExpression Gets or sets summary expression which is used for group summary totals calculation. | StiDataBand | |
| collapsedValue : Object Gets or sets collapsed value of the component. | StiContainer | |
| collapsingIndex : int | StiContainer | |
| columnDirection : int Gets or sets direction of the rendeting columns. | StiDataBand | |
| columnGaps : Number Gets or sets distance between two columns. | StiDataBand | |
| columns : int Gets or sets columns count. | StiDataBand | |
| columnWidth : Number Gets or sets width of column. | StiDataBand | |
| componentPlacement : String | StiComponent | |
| components : StiComponentsCollection Gets or sets a collection of components. | StiContainer | |
| componentStyle : String Gets or sets a style of a component. | StiComponent | |
| componentType : int [override] [read-only] | StiDataBand | |
| conditions : StiConditionsCollection Gets or sets the collection of conditions. | StiComponent | |
| containerInfoV2 : StiContainerInfoV2 [read-only] | StiContainer | |
| count : int [read-only] Gets count of rows. | StiDataBand | |
| countData : int Gets or sets the count of rows for virtual data. | StiDataBand | |
| currentBookmark : StiBookmark Gets or sets current bookmark for this component. | StiComponent | |
| dataBandInfoV1 : StiDataBandInfoV1 [read-only] | StiDataBand | |
| dataBandInfoV2 : StiDataBandInfoV2 [read-only] | StiDataBand | |
| dataRelation : StiDataRelation [read-only] Get link that is used for master-detail reports rendering. | StiDataBand | |
| dataRelationName : String Gets or sets relation name. | StiDataBand | |
| dataSource : StiDataSource [read-only] Get data source that is used for getting data. | StiDataBand | |
| dataSourceName : String Gets or sets name of the Data Source. | StiDataBand | |
| defaultClientRectangle : StiRectangle [override] [read-only] Gets or sets the default client area of a component. | StiBand | |
| delimiterComponent : Boolean Gets or sets a value indicates that this component is used as the delimiter. | StiComponent | |
| displayRectangle : StiRectangle [override]
Gets or sets a rectangle of the component which it fills. | StiBand | |
| dockable : Boolean Gets or sets a value which indicates whether the component will be docked or not. | StiComponent | |
| dockStyle : int [override] Gets or sets a type of the component docking. | StiBand | |
| doubleClickEvent : StiDoubleClickEvent Occurs when user double clicks on the component in the window of viewer. | StiComponent | |
| drillDownParameters : StiDictionaryCollection | StiComponent | |
| enabled : Boolean Gets or sets a value which indicates will this component be available or not. | StiComponent | |
| endRenderEvent : StiEndRenderEvent Occurs when when a band ends to render. | StiDataBand | |
| evenStyle : String Gets or sets value, indicates style of even lines. | StiDataBand | |
| filterEngine : int Gets or sets how a filter will be applied to data - be means of the report generator or by means of changing the SQL query. | StiDataBand | |
| filterMethodHandler : Function | StiDataBand | |
| filterMode : int Gets or sets filter mode. | StiDataBand | |
| filterOn : Boolean Gets or sets value indicates, that filter is turn on. | StiDataBand | |
| filters : StiFiltersCollection Gets or sets the collection of data filters. | StiDataBand | |
| footers : String Gets or sets the list of footers for the hierarchical band. | StiHierarchicalBand | ||
| footerSize : Number [read-only] | StiBand | |
| forceRedrawAll : Boolean [read-only]
Gets a value which indicates whether it is necessary to draw again the whole page when moving the component or
changing its sizes in the designer. | StiComponent | |
| getBookmarkEvent : StiGetBookmarkEvent Occurs when getting a Bookmark for the component. | StiComponent | |
| getCollapsedEvent : StiGetCollapsedEvent Occurs when the Collapsed value is calculated. | StiDataBand | |
| getDrillDownReportEvent : StiGetDrillDownReportEvent Occurs when it is required to get a report for the Drill-Down operation. | StiComponent | |
| getHyperlinkEvent : StiGetHyperlinkEvent Occurs when getting a Hyperlink for the component. | StiComponent | |
| getTagEvent : StiGetTagEvent Occurs when getting a Tag for the component. | StiComponent | |
| getToolTipEvent : StiGetToolTipEvent Occurs when getting a ToolTip for the component. | StiComponent | |
| growToHeight : Boolean [override] | StiBand | |
| guid : String | StiComponent | |
| hasSelected : Boolean [read-only] Internal use only. | StiContainer | |
| headerEndColor : StiColor [override] [read-only] | StiHierarchicalBand | ||
| headers : String Gets or sets the list of headers for the hierarchical band. | StiHierarchicalBand | ||
| headerSize : Number [read-only] Gets the header height. | StiBand | |
| headerStartColor : StiColor [override] [read-only] | StiHierarchicalBand | ||
| height : Number Gets or sets height of a component. | StiComponent | |
| hierarchicalBandInfoV2 : StiHierarchicalBandInfoV2 [read-only] | StiHierarchicalBand | ||
| highlightState : int Gets or sets a state of highlight. | StiComponent | |
| hyperlink : StiHyperlinkExpression Gets or sets an expression to fill a component hyperlink. | StiComponent | |
| hyperlinkValue : String Gets or sets hyperlink of a component. | StiComponent | |
| ignoreNamingRule : Boolean Internal use only. | StiComponent | |
| indent : Number Gets or sets indent from the left side of band for offset of data levels. | StiHierarchicalBand | ||
| inherited : Boolean | StiComponent | |
| interaction : StiInteraction Gets interaction options of this component. | StiComponent | |
| isAllowUseInTableMode : Boolean [read-only] Возможно ли добавиль компонент в групповое выделение | StiComponent | |
| isAutomaticDock : Boolean [override] [read-only] | StiBand | |
| isBof : Boolean Gets value, indicates that the position indicates to the beginning of data. | StiDataBand | |
| isBusinessObjectEmpty : Boolean [read-only] | StiDataBand | |
| isCross : Boolean [read-only] | StiComponent | |
| isDataSourceEmpty : Boolean [read-only] | StiDataBand | |
| isDesigning : Boolean [read-only] Gets a value which indicates that the report in which a component is placed is being designed. | StiComponent | |
| isEmpty : Boolean [read-only] Gets value indicates that no data. | StiDataBand | |
| isEnabled : Boolean [read-only] | StiComponent | |
| isEof : Boolean Gets value indicates that the position indicates to the end of data. | StiDataBand | |
| isExporting : Boolean [read-only] Gets or sets value, which indicates that the report is exporting. | StiComponent | |
| isPrinting : Boolean [read-only] Gets a value which indicates that the component has already been printed. | StiComponent | |
| isRendered : Boolean Gets or sets a value which indicates whether a component is rendered or not. | StiComponent | |
| isSelected : Boolean Gets or sets value indicates is the component selected or not. | StiComponent | |
| isThumbnails : Boolean [read-only] | StiComponent | |
| keepDetails : int Gets or sets value indicates how details are to be kept together with this DataBand. | StiDataBand | |
| keepDetailsTogether : Boolean Gets or sets value indicates that details are to be kept together with this DataBand. | StiDataBand | |
| keyDataColumn : String Gets or sets column which contains data key. | StiHierarchicalBand | ||
| left : Number [override] Gets or sets left position of a component. | StiBand | |
| line : int Gets the number of line from the beginning of the group formation. | StiDataBand | |
| lineThrough : int Gets the number of line from the beginning of the report formation. | StiDataBand | |
| linked : Boolean Gets or sets a value which indicates whether the object snap to the container is turned on. | StiComponent | |
| localizedCategory : String [read-only] Gets a localized name of the component category. | StiBase | |
| localizedName : String [override] [read-only] Gets a localized component name. | StiHierarchicalBand | ||
| locked : Boolean Gets or sets a value which indicates that moving is locked. | StiComponent | |
| masterComponent : StiComponent Gets or sets the master-component. | StiDataBand | |
| masterKeyDataColumn : String Gets or sets column which contains data master key. | StiHierarchicalBand | ||
| maxHeight : Number Gets or sets maximal height of band. | StiBand | |
| maxSize : StiSize [override] | StiBand | |
| minHeight : Number Gets or sets minimal height of band. | StiBand | |
| minRowsInColumn : int Gets or sets minimum count of the rows in one column. | StiDataBand | |
| minSize : StiSize [override] | StiBand | |
| mouseEnterEvent : StiMouseEnterEvent Occurs when user enters the mouse into the area of the component in the window of viewer. | StiComponent | |
| mouseLeaveEvent : StiMouseLeaveEvent Occurs when user leaves the mouse into the area of the component in the window of viewer. | StiComponent | |
| name : String [override] Gets or sets a name of a component. | StiComponent | |
| nestedLevel : int [read-only] Gets nested level of this band. | StiBand | |
| newColumnAfter : Boolean If the value of this property is true, then, after output of a band, a new column will be generated. | StiDynamicBand | |
| newColumnBefore : Boolean If the value of this property is true, then, before output of a band, a new column will be generated. | StiDynamicBand | |
| newPageAfter : Boolean If the value of this property is true, then, after output of a band, a new page will be generated. | StiDynamicBand | |
| newPageBefore : Boolean If the value of this property is true, then, before output of a band, a new page will be generated. | StiDynamicBand | |
| oddStyle : String Gets or sets value, indicates style of odd lines. | StiDataBand | |
| page : StiPage Gets or sets the page on which an object is located. | StiComponent | |
| parent : StiContainer Gets or sets the container in which an object is located. | StiComponent | |
| parentBookmark : StiBookmark Gets or sets parent bookmark for this component. | StiComponent | |
| parentComponentIsBand : Boolean = false Если true, то Parent компонент этого контейнера является Band. | StiContainer | |
| parentValue : String Gets or sets column which contains parent value which identifies parent rows. | StiHierarchicalBand | ||
| position : int Gets the current position. | StiDataBand | |
| printable : Boolean [override] | StiBand | |
| printAtBottom : Boolean Gets or sets value indicates that the footer is printed at bottom of page. | StiDynamicBand | |
| printIfDetailEmpty : Boolean Gets or sets value indicates that if detail is empty then the master data must be printed anyway. | StiDataBand | |
| printOn : int Gets or sets a value which indicates on what pages component will be printed. | StiComponent | |
| printOnAllPages : Boolean Gets or sets value indicates that the component is printed on all pages. | StiDataBand | |
| priority : int [override] [read-only] | StiDataBand | |
| properties : StiRepositoryItems | StiService | |
| ref : int | StiBase | |
| renderedCount : int Gets or sets a value which indicates how many times a component is rendered. | StiComponent | |
| renderingEvent : StiRenderingEvent Occurs when a band rendering. | StiDataBand | |
| report : StiReport Gets or sets the report in which the component is located. | StiComponent | |
| resetPageNumber : Boolean [override] Allows to reset page number on this component. | StiDataBand | |
| restrictions : int Gets or sets value which indicates the restrictions of a component. | StiComponent | |
| right : Number [read-only] Gets right position of a component. | StiComponent | |
| rightToLeft : Boolean Gets or sets horizontal column direction. | StiDataBand | |
| selectedLine : int Gets or sets the selected line in rows which is output by this data band. | StiDataBand | |
| selectionTick : int | StiComponent | |
| selectRectangle : StiRectangle [override] | StiBand | |
| serviceCategory : String [read-only] Gets a service category. | StiService | |
| serviceInfo : String [read-only] Gets a service description. | StiService | |
| serviceName : String [override] [read-only] Gets a service name. | StiBase | |
| serviceType : Class [read-only] Gets a service type. | StiService | |
| shift : Boolean Gets or sets a value which indicates that this component can be shifted. | StiComponent | |
| shiftMode : int [override] | StiBand | |
| showQuickButtons : Boolean Gets or sets a value which indicates whether it is necessary to show quick buttons. | StiComponent | |
| skipFirst : Boolean If the value of this property is true, then, a new page/column will be generated only starting from the second case. | StiDynamicBand | |
| sort : Array Gets or sets the array of strings that describes rules of sorting. | StiDataBand | |
| states : StiStatesManager [read-only] Gets the component states manager. | StiComponent | |
| tag : StiTagExpression Gets or sets the expression to fill a component tag. | StiComponent | |
| tagValue : String Gets or sets tag of a component. | StiComponent | |
| toolTip : StiToolTipExpression Gets or sets the expression to fill a component tooltip. | StiComponent | |
| toolTipValue : String Gets or sets a component tips. | StiComponent | |
| top : Number [override] Gets or sets top position of a component. | StiBand | |
| useParentStyles : Boolean Gets or sets a value which indicates that this component must use styles from parent component. | StiComponent | |
| width : Number [override] Gets or sets width of a component. | StiBand | |
| Method | Defined By | ||
|---|---|---|---|
| StiHierarchicalBand | |||
| alignTo(aligning:String):void Aligns, in the rectangle of selected objects, all selected objects. | StiContainer | |
| alignToGrid(comp:StiComponent = null):void Aligns to grid all selected components in the container. | StiContainer | |
| applyConditions(sender:Object, conditions:StiArrayList):void | StiComponent | |
| breakk(dividedComponent:StiComponent, devideFactor:Number):Boolean [override] Divides content of components in two parts. | StiDynamicBand | |
| bringToFront():void Brings to front objects of the list in the container. | StiContainer | |
| canContainIn(component:StiComponent):Boolean [override] | StiBand | |
| changePosition(delta:StiRectangle):void Changes the position of the selected component. | StiContainer | |
| checkForParentComponent(comp:StiComponent):Boolean | StiComponent | |
| clearAllStates():void [override] Clear all earlier saved object states. | StiContainer | |
| clone(... args):Object [override] | StiDataBand | |
| componentToPage(value:Number):Number
Converts a rectangle from the parent-container coordinates into coordinates of a page. | StiComponent | |
|
Converts a rectangle from the parent-container coordinates into coordinates of a page. | StiComponent | |
|
Converts a rectangle from the parent-container coordinates into coordinates of a page. | StiComponent | |
| Converts a rectangle from container coordinates into coordinates of a page. | StiContainer | |
| Converts a point of coordinates of the container into coodinates of a page. | StiContainer | |
| [override] | StiDataBand | |
| correct(onlySelect:Boolean = false):void Corrects in the container all objects which require motion between containers. | StiContainer | |
| deserializeDocument(value:XMLNode):void | StiContainer | |
| doBookmark():void Invokes the GetBookmark event. | StiComponent | |
| dockToContainer():void Docks the component and all of its subordinate components. | StiComponent | |
| StiComponent | ||
| doGetBookmark():void Raises the GetBookmark event. | StiComponent | |
| [static] | StiComponent | |
equals(object:Object):Boolean [override] | StiHierarchicalBand | ||
| first():void Sets the position at the beginning. | StiDataBand | |
| [override] | StiContainer | |
| getBorder():Object Returns a frame of the object of the type IStiBorder being met first. | StiContainer | |
| getColumnWidth():Number | StiDataBand | |
| getComponentInControl(x:Number, y:Number, usePage:Boolean):StiComponent Returns an object in which zone of controlling coordinates are got. | StiContainer | |
| getComponentInPoint(x:Number, y:Number):StiComponent Returns an object in which zone of controlling coordinates are got. | StiContainer | |
| Returns the list of all components which are located in the container. | StiContainer | |
| Returns an container in which client zone coordinates are got. | StiContainer | |
| Returns the DataBand in which the component is located. | StiComponent | |
| Returns a rectangle of the component showing. | StiComponent | |
| Returns the first docked and selected component. | StiContainer | |
| Retuns an empty rectangle to which docking is possible. | StiComponent | |
| Returns the first selected component. | StiContainer | |
| Returns the GroupHeaderBand in which the component is located. | StiComponent | |
| getHeaderText():String [override] | StiDataBand | |
| getIncorrect(onlySelect:Boolean = false):StiComponentsCollection Returns the list of all objects which require motion between containers. | StiContainer | |
| getLink():Object
Returns linked of the object being met first. | StiContainer | |
| getLock():Object
Returns lock of the object being met first. | StiContainer | |
| getPaintRectangle(convertToHInches:Boolean = true, convertZoom:Boolean = true, docking:Boolean = true):StiRectangle Makes all necessary coversions for showing an object and returns its coordinates. | StiComponent | |
| getQuickInfo():String | StiComponent | |
| getReport():Object | StiComponent | |
| Returns the array of the selected components. | StiContainer | |
| Returns the array of the selected objects including child of the selected objects. | StiContainer | |
| Returns the rectangle that includes all selected objects in the container. | StiContainer | |
| getShortTypeName():String Get a short object type name (without library path). | StiObject | |
| getType():Class | StiObject | |
| getTypeName():String | StiObject | |
| StiComponent | ||
| invert():void Invert selection of component. | StiComponent | |
| invokeAfterPrint(sender:Object):void Raises the AfterPrint event. | StiComponent | |
| invokeBeforePrint(sender:Object):void Raises the BeforePrint event. | StiComponent | |
| invokeEvents():void | StiComponent | |
| invokeRendering():void | StiDataBand | |
| isExportAsImage(format:int):Boolean | StiComponent | |
| isParentSelect(component:StiComponent):Boolean [static] Retuns true if one of the parent component is selected. | StiComponent | |
| isSimple(object:*):Boolean [static] | StiObject | |
| last():void Move on the last row. | StiDataBand | |
| makeHorizontalSpacingEqual():void Puts components which are equivalent to their width. | StiContainer | |
| makeSameHeight(height:Number):void Sets the height to all selected objects. | StiContainer | |
| makeSameSize(size:StiSize):void Sets the size to all selected objects. | StiContainer | |
| makeSameWidth(width:Number):void Sets the width to all selected objects. | StiContainer | |
| makeVerticalSpacingEqual():void Puts components which are equal in their height. | StiContainer | |
memberwiseClone():Object [override] | StiHierarchicalBand | ||
| moveBackward():void Moves backward objects of the list in the container. | StiContainer | |
| moveComponentsToPage():void Converts coordinates of all objects into coordinates of a page and moves objects on the page. | StiContainer | |
| moveForward():void Moves forward objects of the list in the container. | StiContainer | |
| newGuid():void | StiComponent | |
| next():void Move on the next row. | StiDataBand | |
| normalize():void Normalizes all selected objects in the container. | StiContainer | |
| offsetLocation(offsetX:Number, offsetY:Number):void | StiContainer | |
| packService():void [override] Packs a service. | StiComponent | |
|
Converts a rectangle from coordinates of a page into the parent-container coordinates. | StiComponent | |
|
Converts a rectangle from coordinates of a page into the parent-container coordinates. | StiComponent | |
| Converts a rectangle from coordinates of a page into container coordinates. | StiContainer | |
| Converts a point from coordinates of a page into container coordinates. | StiContainer | |
| paint(args:StiPaintArgs):void | StiComponent | |
| paintSelection(args:StiPaintArgs):void | StiComponent | |
| prepare():void Подготавливает компонент для рендеринга. | StiComponent | |
| prior():void Move on the previous row. | StiDataBand | |
| processRemoveComponent():void | StiComponent | |
| [override] | StiDataBand | |
| renderMaster():void | StiDataBand | |
| reset():void Reset selection of component. | StiComponent | |
| resetSelection():void Resets selection from all selected objects in the container. | StiContainer | |
| restoreState(stateName:String):void [override] Restores the earlier saved object state. | StiDataBand | |
| saveState(stateName:String):void [override] Saves the current state of an object. | StiDataBand | |
| select():void Select component. | StiComponent | |
| selectAll():void Select all components in container. | StiContainer | |
| selectComponent(component:StiComponent):void Selects the specified component in the container. | StiContainer | |
| selectInRectangle(rect:StiRectangle):void Selects all objects in the container which intersect with the specified rectangle. | StiContainer | |
| selectInRectangleCheckBands(rect:StiRectangle):void | StiContainer | |
| sendToBack():void Sends to back objects of the list in the container. | StiContainer | |
| serializeDocument():XMLNode | StiContainer | |
|
Sets StiBorder from all selected objects in the container. | StiContainer | |
| setCenterHorizontally():void Centers horizontally all selected objects. | StiContainer | |
| setCenterVertically():void Centers vertically all selected objects. | StiContainer | |
| setLink(linked:Boolean):void Sets Link from all selected objects in the container. | StiContainer | |
| setLock(locked:Boolean):void Sets Lock from all selected objects in the container. | StiContainer | |
| setPaintRectangle(rect:StiRectangle):void Internal use only. | StiComponent | |
| setParentStylesToChilds(style:StiBaseStyle = null):void | StiContainer | |
| setReportVariables():void | StiComponent | |
| sortByPriority():void | StiContainer | |
| toString():String
Returns an Alias of the report or the Name of the report. | StiComponent | |
| unPrepare():void Очищает компонент после рендеринга. | StiComponent | |
| footers | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesfooters:StringGets or sets the list of footers for the hierarchical band.
public function get footers():String public function set footers(value:String):void| headerEndColor | property |
headerEndColor:StiColor [read-only] [override] public function get headerEndColor():StiColor| headers | property |
headers:StringGets or sets the list of headers for the hierarchical band.
public function get headers():String public function set headers(value:String):void| headerStartColor | property |
headerStartColor:StiColor [read-only] [override] public function get headerStartColor():StiColor| hierarchicalBandInfoV2 | property |
hierarchicalBandInfoV2:StiHierarchicalBandInfoV2 [read-only] public function get hierarchicalBandInfoV2():StiHierarchicalBandInfoV2| indent | property |
indent:NumberGets or sets indent from the left side of band for offset of data levels.
public function get indent():Number public function set indent(value:Number):void| keyDataColumn | property |
keyDataColumn:StringGets or sets column which contains data key.
public function get keyDataColumn():String public function set keyDataColumn(value:String):void| localizedName | property |
localizedName:String [read-only] [override] Gets a localized component name.
public function get localizedName():String| masterKeyDataColumn | property |
masterKeyDataColumn:StringGets or sets column which contains data master key.
public function get masterKeyDataColumn():String public function set masterKeyDataColumn(value:String):void| parentValue | property |
parentValue:StringGets or sets column which contains parent value which identifies parent rows.
public function get parentValue():String public function set parentValue(value:String):void| StiHierarchicalBand | () | Constructor |
public function StiHierarchicalBand()| equals | () | method |
override public function equals(object:Object):BooleanParameters
object:Object |
Boolean |
| memberwiseClone | () | method |
override public function memberwiseClone():ObjectReturnsObject |