stimulsoft.report.components.bands.StiFooterBand

Public Properties

	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
		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
		canBreak : Boolean [override] Gets or sets value which indicates whether the component can or cannot break its contents on several pages.	StiFooterBand
		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
		collapsedValue : Object Gets or sets collapsed value of the component.	StiContainer
		collapsingIndex : int	StiContainer
		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] Gets the type of processing when printing.	StiFooterBand
		conditions : StiConditionsCollection Gets or sets the collection of conditions.	StiComponent
		containerInfoV2 : StiContainerInfoV2 [read-only]	StiContainer
		currentBookmark : StiBookmark Gets or sets current bookmark for this component.	StiComponent
		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
		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
		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] Gets header end color.	StiFooterBand
		headerSize : Number [read-only] Gets the header height.	StiBand
		headerStartColor : StiColor [override] [read-only] Gets header start color.	StiFooterBand
		height : Number Gets or sets height of a component.	StiComponent
		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
		inherited : Boolean	StiComponent
		interaction : StiInteraction Gets interaction options of this component.	StiComponent
		isAllowUseInTableMode : Boolean [read-only] Возможно ли добавиль компонент в групповое выделение	StiComponent
		isAutomaticDock : Boolean [override] [read-only]	StiBand
		isCross : Boolean [read-only]	StiComponent
		isDesigning : Boolean [read-only] Gets a value which indicates that the report in which a component is placed is being designed.	StiComponent
		isEnabled : Boolean [read-only]	StiComponent
		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
		keepFooterTogether : Boolean Gets or sets value indicates that the footer is printed with data.	StiFooterBand
		left : Number [override] Gets or sets left position of a component.	StiBand
		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.	StiFooterBand
		locked : Boolean Gets or sets a value which indicates that moving is locked.	StiComponent
		maxHeight : Number Gets or sets maximal height of band.	StiBand
		maxSize : StiSize [override]	StiBand
		minHeight : Number Gets or sets minimal height of band.	StiBand
		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
		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
		printable : Boolean [override]	StiBand
		printAtBottom : Boolean Gets or sets value indicates that the footer is printed at bottom of page.	StiDynamicBand
		printIfEmpty : Boolean Gets or sets value indicates that the footer is printed if data not present.	StiFooterBand
		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.	StiFooterBand
		printOnEvenOddPages : int Gets or sets value indicates that the component is printed on even-odd pages.	StiFooterBand
		priority : int [override] [read-only] Gets a component priority.	StiFooterBand
		properties : StiRepositoryItems	StiService
		ref : int	StiBase
		renderedCount : int Gets or sets a value which indicates how many times a component is rendered.	StiComponent
		report : StiReport Gets or sets the report in which the component is located.	StiComponent
		resetPageNumber : Boolean Allows to reset page number on this band.	StiBand
		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
		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
		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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		StiFooterBand(rect:StiRectangle = null)	StiFooterBand
		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]	StiFooterBand
		componentToPage(value:Number):Number Converts a rectangle from the parent-container coordinates into coordinates of a page.	StiComponent
		componentToPageP(point:StiPoint):StiPoint Converts a rectangle from the parent-container coordinates into coordinates of a page.	StiComponent
		componentToPageR(rect:StiRectangle):StiRectangle Converts a rectangle from the parent-container coordinates into coordinates of a page.	StiComponent
		containerToPage(rect:StiRectangle):StiRectangle Converts a rectangle from container coordinates into coordinates of a page.	StiContainer
		containerToPageP(point:StiPoint):StiPoint Converts a point of coordinates of the container into coodinates of a page.	StiContainer
		convert(oldUnit:StiUnit, newUnit:StiUnit, convertComponents:Boolean = true):void [override] Converts a component out of one unit into another.	StiContainer
		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
		dockToContainerRectangle(rect:StiRectangle):StiRectangle	StiComponent
		doGetBookmark():void Raises the GetBookmark event.	StiComponent
		doOffsetRect(component:StiComponent, rect:StiRectangle, offsetRect:StiRectangle):StiRectangle [static]	StiComponent
		equals(object:Object):Boolean [override]	StiFooterBand
		getActualSize():StiSize [override]	StiContainer
		getBorder():Object Returns a frame of the object of the type IStiBorder being met first.	StiContainer
		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
		getComponents():StiComponentsCollection Returns the list of all components which are located in the container.	StiContainer
		getContainerInRect(rect:StiRectangle, component:StiComponent):StiContainer Returns an container in which client zone coordinates are got.	StiContainer
		getDataBand():StiDataBand Returns the DataBand in which the component is located.	StiComponent
		getDisplayRectangle():StiRectangle Returns a rectangle of the component showing.	StiComponent
		getDockableComponent():StiComponent Returns the first docked and selected component.	StiContainer
		getDockRegion(parent:StiComponent, useColumns:Boolean = true):StiRectangle Retuns an empty rectangle to which docking is possible.	StiComponent
		getFirstSelectableComponent():StiComponent Returns the first selected component.	StiContainer
		getGroupHeaderBand():StiGroupHeaderBand Returns the GroupHeaderBand in which the component is located.	StiComponent
		getHeaderText():String Returns the band header text.	StiBand
		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
		getSelectedComponents():StiComponentsCollection Returns the array of the selected components.	StiContainer
		getSelectedComponentsWithChilds():StiComponentsCollection Returns the array of the selected objects including child of the selected objects.	StiContainer
		getSelectedRectangle():StiRectangle 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
		internalRender():StiComponent	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
		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
		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]	StiFooterBand
		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
		normalize():void Normalizes all selected objects in the container.	StiContainer
		offsetLocation(offsetX:Number, offsetY:Number):void	StiContainer
		packService():void [override] Packs a service.	StiComponent
		pageToComponentP(point:StiPoint):StiPoint Converts a rectangle from coordinates of a page into the parent-container coordinates.	StiComponent
		pageToComponentR(rect:StiRectangle):StiRectangle Converts a rectangle from coordinates of a page into the parent-container coordinates.	StiComponent
		pageToContainer(rect:StiRectangle):StiRectangle Converts a rectangle from coordinates of a page into container coordinates.	StiContainer
		pageToContainerP(point:StiPoint):StiPoint 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
		processRemoveComponent():void	StiComponent
		render():StiComponent	StiComponent
		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.	StiContainer
		saveState(stateName:String):void [override] Saves the current state of an object.	StiContainer
		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
		setBorder(border:StiBorder):void 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

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		allowPrintOn():Boolean	StiComponent
		checkBlockedException(propertyName:String):void	StiContainer
		setDirectDisplayRectangle(rect:StiRectangle):void	StiComponent

Protected Constants

Hide Inherited Protected Constants

Show Inherited Protected Constants

	Constant		Defined By
		PropertyBlocked : Object [static]	StiContainer
		PropertyComponentStyle : Object [static]	StiComponent
		PropertyDelimiterComponent : Object [static]	StiComponent
		PropertyDockable : Object [static]	StiComponent
		PropertyInherited : Object [static]	StiComponent
		PropertyLinked : Object [static]	StiComponent
		PropertyLocked : Object [static]	StiComponent
		PropertyRenderedCount : Object [static]	StiComponent
		PropertyRestrictions : Object [static]	StiComponent
		PropertySelectionTick : Object [static]	StiComponent
		PropertyShowQuickButtons : Object [static]	StiComponent
		PropertyUseParentStyles : Object [static]	StiComponent

Property Detail

canBreak

property

canBreak:Boolean[override]

Gets or sets value which indicates whether the component can or cannot break its contents on several pages.

Implementation
public function get canBreak():Boolean
public function set canBreak(value:Boolean):void

componentType

property

componentType:int [read-only] [override]

Gets the type of processing when printing.

Implementation
public function get componentType():int

headerEndColor

property

headerEndColor:StiColor [read-only] [override]

Gets header end color.

Implementation
public function get headerEndColor():StiColor

headerStartColor

property

headerStartColor:StiColor [read-only] [override]

Gets header start color.

Implementation
public function get headerStartColor():StiColor

keepFooterTogether

property

keepFooterTogether:Boolean

Gets or sets value indicates that the footer is printed with data.

Implementation
public function get keepFooterTogether():Boolean
public function set keepFooterTogether(value:Boolean):void

localizedName

property

localizedName:String [read-only] [override]

Gets a localized component name.

Implementation
public function get localizedName():String

printIfEmpty

property

printIfEmpty:Boolean

Gets or sets value indicates that the footer is printed if data not present.

Implementation
public function get printIfEmpty():Boolean
public function set printIfEmpty(value:Boolean):void

printOnAllPages

property

printOnAllPages:Boolean

Gets or sets value indicates that the component is printed on all pages.

Implementation
public function get printOnAllPages():Boolean
public function set printOnAllPages(value:Boolean):void

printOnEvenOddPages

property

printOnEvenOddPages:int

Gets or sets value indicates that the component is printed on even-odd pages.

Implementation
public function get printOnEvenOddPages():int
public function set printOnEvenOddPages(value:int):void

priority

property

priority:int [read-only] [override]

Gets a component priority.

Implementation
public function get priority():int

Constructor Detail

StiFooterBand

()

Constructor

public function StiFooterBand(rect:StiRectangle = null)

Parameters

rect:StiRectangle (default = null)

Method Detail

clone

()

method

override public function clone(... args):Object

Parameters

... args

Returns

Object

equals

()

method

override public function equals(object:Object):Boolean

Parameters

object:Object

Returns

Boolean

memberwiseClone

()

method

override public function memberwiseClone():Object

Returns

Object

Mon Mar 27 2017, 09:08 AM +03:00

Stimulsoft Reports.Flex Class Reference	All Packages \| All Classes \| Index \| Frames No Frames
StiFooterBand	Properties \| Methods

Package	stimulsoft.report.components.bands
Class	public class StiFooterBand
Inheritance	StiFooterBand StiDynamicBand StiBand StiContainer StiComponent StiBase StiService StiObject Object
Implements	IStiPrintOnAllPages, IStiPrintIfEmpty, IStiKeepFooterTogether, IStiPrintOnEvenOddPages
Subclasses	StiColumnFooterBand, StiCrossFooterBand