stimulsoft.report.components.StiPage

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
		beforePrintEvent : StiBeforePrintEvent Occurs before printing of the component.	StiComponent
		beginRenderEvent : StiBeginRenderEvent Occurs when when a page begins to render.	StiPage
		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 [override] [read-only] Gets bottom margin.	StiPage
		brush : StiBrush Gets or sets a brush to fill a component.	StiContainer
		canBreak : Boolean [override]	StiPage
		canGrow : Boolean [override]	StiPage
		canShrink : Boolean [override]	StiPage
		clickEvent : StiClickEvent Occurs when user clicks on the component in the window of viewer.	StiComponent
		clientRectangle : StiRectangle [override] Gets or sets the client area of a component.	StiPage
		collapsedValue : Object Gets or sets collapsed value of the component.	StiContainer
		collapsingIndex : int	StiContainer
		columnBeginRenderEvent : StiColumnBeginRenderEvent Occurs when start render column.	StiPage
		columnEndRenderEvent : StiColumnEndRenderEvent Occurs when end render column.	StiPage
		columnGaps : Number Gets or sets distance between two columns.	StiPanel
		columns : int Gets or sets columns count.	StiPanel
		columnWidth : Number Gets or sets width of column.	StiPanel
		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.	StiContainer
		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
		currentHeightSegment : int Gets or sets the current height of a page segment.	StiPage
		currentWidthSegment : int Gets or sets the current width of a page segment.	StiPage
		defaultClientRectangle : StiRectangle [override] [read-only] Gets or sets the default client area of a component.	StiContainer
		delimiterComponent : Boolean Gets or sets a value indicates that this component is used as the delimiter.	StiComponent
		denyDrawSegmentMode : Boolean Internal use only.	StiPage
		displayRectangle : StiRectangle [override] Gets or sets a rectangle of the component which it fills.	StiPage
		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.	StiPage
		doubleClickEvent : StiDoubleClickEvent Occurs when user double clicks on the component in the window of viewer.	StiComponent
		drillDownActivated : Boolean	StiPage
		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 page ends to render.	StiPage
		excelSheet : StiExcelSheetExpression Gets or sets an expression used for generation name of excel sheet.	StiPage
		excelSheetValue : String Gets or sets name of excel sheet.	StiPage
		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
		getExcelSheetEvent : StiGetExcelSheetEvent Occurs when the ExcelSheet is calculated.	StiPage
		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
		gridSize : Number [read-only] Gets grid size in the unit.	StiPage
		growToHeight : Boolean [override]	StiPage
		guid : String	StiComponent
		hasSelected : Boolean [read-only] Internal use only.	StiContainer
		height : Number [override] Gets or sets height.	StiPage
		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] Gets value indicates that this is an automatic docking.	StiPage
		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
		isPrinted : Boolean	StiPage
		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
		largeHeight : Boolean Gets or sets value indicates that this page has in designer large height.	StiPage
		largeHeightFactor : int Gets or sets large height factor for LargeHeight property of this page.	StiPage
		left : Number [override] Gets or sets left margin.	StiPage
		linked : Boolean [override]	StiPage
		localizedCategory : String [read-only] Gets a localized name of the component category.	StiBase
		localizedName : String [override] [read-only] Gets a localized component name.	StiPage
		locked : Boolean [override]	StiPage
		lockHighlight : Boolean	StiPage
		margins : StiMargins Gets or sets page margins.	StiPage
		maxSize : StiSize [override]	StiPage
		minSize : StiSize [override]	StiPage
		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
		numberOfCopies : int Gets or sets a value of number of copies of the current page.	StiPage
		offsetRectangle : StiRectangle Gets or sets offset of the selected components on the page.	StiPage
		orientation : int Gets or sets page orientation.	StiPage
		page : StiPage [override]	StiPage
		pageHeight : Number Gets or sets the total height of the page.	StiPage
		pageInfoV2 : StiPageInfoV2 [read-only]	StiPage
		pageWidth : Number Gets or sets the total width of the page.	StiPage
		paperSize : int Gets or sets the page size.	StiPage
		paperSourceFirstPage : int Gets or sets the paper source for first page.	StiPage
		paperSourceOfFirstPage : String Gets or sets the paper source for first page.	StiPage
		paperSourceOfOtherPages : String Gets or sets the paper source for other pages.	StiPage
		paperSourceOtherPages : int Gets or sets the paper source for other pages.	StiPage
		parent : StiContainer [override]	StiPage
		parentBookmark : StiBookmark Gets or sets parent bookmark for this component.	StiComponent
		parentComponentIsBand : Boolean = false Если true, то Parent компонент этого контейнера является Band.	StiContainer
		printable : Boolean [override]	StiPage
		printHeadersFootersFromPreviousPage : Boolean Gets or sets value which indicates that, on this page, it is necessary to print headers and footers of the previous page.	StiPage
		printOn : int [override]	StiPage
		printOnPreviousPage : Boolean Gets or sets value that indicates that the page will start to be rendered on the free space of the previous page.	StiPage
		priority : int [override] [read-only] Gets a component priority.	StiPanel
		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 page rendering.	StiPage
		report : StiReport [override] Gets or sets the report in which the page is located.	StiPage
		reportUnit : StiUnit Used for save/load page.	StiPage
		resetPageNumber : Boolean Allows to reset page number on this page.	StiPage
		restrictions : int [override]	StiPage
		right : Number [override] [read-only] Gets right margin.	StiPage
		rightToLeft : Boolean Gets or sets horizontal column direction.	StiPanel
		segmentPerHeight : int Gets or sets the number of segments per height.	StiPage
		segmentPerWidth : int Gets or sets the number of segments per width.	StiPage
		selectedComponents : StiArrayList [read-only]	StiPage
		selectedRectangle : StiRectangle Internal use only.	StiPage
		selectionTick : int	StiComponent
		selectRectangle : StiRectangle Gets or sets a rectangle of a component selection.	StiComponent
		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]	StiPage
		showQuickButtons : Boolean Gets or sets a value which indicates whether it is necessary to show quick buttons.	StiComponent
		skip : Boolean Gets or sets value, indicates that, when rendering of the report, this page of the report is to be skipped.	StiPage
		states : StiStatesManager [read-only] Gets the component states manager.	StiComponent
		stopBeforePrint : int Gets or sets the page number.	StiPage
		stretchToPrintArea : Boolean Gets or sets value, indicates that, when printing, a page stretches into print area.	StiPage
		tag : StiTagExpression Gets or sets the expression to fill a component tag.	StiComponent
		tagValue : String Gets or sets tag of a component.	StiComponent
		titleBeforeHeader : Boolean Gets or sets value, indicates that it is necessary to put the report title before the page header.	StiPage
		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 margin.	StiPage
		unit : StiUnit [read-only]	StiPage
		unlimitedBreakable : Boolean Gets or sets value indicates that when printing of multiple-sheet cross-reports, columns and strings are to be broken.	StiPage
		unlimitedHeight : Boolean Gets or sets value, indicates that the page has an unlimited height.	StiPage
		unlimitedWidth : Boolean Gets or sets value, indicates that the page has an unlimited width.	StiPage
		useParentStyles : Boolean [override]	StiPage
		watermark : StiWatermark Gets or sets watermark of the page.	StiPage
		width : Number [override] Gets or sets width.	StiPage
		zoom : Number [read-only] Gets zoom of a report.	StiPage

	Method	Defined By
		StiPage(report:StiReport = null)	StiPage
		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 Divides content of components in two parts.	StiContainer
		bringToFront():void Brings to front objects of the list in the container.	StiContainer
		canContainIn(component:StiComponent):Boolean Specifies that this component may be located in the specified component.	StiComponent
		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
		clearPage():void	StiPage
		clone(... args):Object [override]	StiPage
		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.	StiPage
		convertFromHInches(unit:StiUnit, value:Number):Number	StiPage
		convertToHInches(unit:StiUnit, value:Number):Number	StiPage
		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]	StiPage
		getActualSize():StiSize [override]	StiContainer
		getBorder():Object Returns a frame of the object of the type IStiBorder being met first.	StiContainer
		getColumnWidth():Number	StiPanel
		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
		getComponentsCount(container:StiContainer = null):int	StiPage
		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
		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 [override]	StiPage
		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]	StiPage
		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

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

	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

beginRenderEvent

property

beginRenderEvent:StiBeginRenderEvent

Occurs when when a page begins to render.

Implementation
public function get beginRenderEvent():StiBeginRenderEvent
public function set beginRenderEvent(value:StiBeginRenderEvent):void

bottom

property

bottom:Number [read-only] [override]

Gets bottom margin.

Implementation
public function get bottom():Number

canBreak

property

canBreak:Boolean[override]

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

canGrow

property

canGrow:Boolean[override]

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

canShrink

property

canShrink:Boolean[override]

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

clientRectangle

property

clientRectangle:StiRectangle[override]

Gets or sets the client area of a component.

Implementation
public function get clientRectangle():StiRectangle
public function set clientRectangle(value:StiRectangle):void

columnBeginRenderEvent

property

columnBeginRenderEvent:StiColumnBeginRenderEvent

Occurs when start render column.

Implementation
public function get columnBeginRenderEvent():StiColumnBeginRenderEvent
public function set columnBeginRenderEvent(value:StiColumnBeginRenderEvent):void

columnEndRenderEvent

property

columnEndRenderEvent:StiColumnEndRenderEvent

Occurs when end render column.

Implementation
public function get columnEndRenderEvent():StiColumnEndRenderEvent
public function set columnEndRenderEvent(value:StiColumnEndRenderEvent):void

currentHeightSegment

property

currentHeightSegment:int

Gets or sets the current height of a page segment.

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

currentWidthSegment

property

currentWidthSegment:int

Gets or sets the current width of a page segment.

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

denyDrawSegmentMode

property

denyDrawSegmentMode:Boolean

Internal use only.

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

displayRectangle

property

displayRectangle:StiRectangle[override]

Gets or sets a rectangle of the component which it fills. Docking occurs in accordance to the area (Cross - components are docked by ClientRectangle).

Implementation
public function get displayRectangle():StiRectangle
public function set displayRectangle(value:StiRectangle):void

dockStyle

property

dockStyle:int[override]

Gets or sets a type of the component docking.

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

drillDownActivated

property

drillDownActivated:Boolean

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

endRenderEvent

property

endRenderEvent:StiEndRenderEvent

Occurs when when a page ends to render.

Implementation
public function get endRenderEvent():StiEndRenderEvent
public function set endRenderEvent(value:StiEndRenderEvent):void

excelSheet

property

excelSheet:StiExcelSheetExpression

Gets or sets an expression used for generation name of excel sheet.

Implementation
public function get excelSheet():StiExcelSheetExpression
public function set excelSheet(value:StiExcelSheetExpression):void

excelSheetValue

property

excelSheetValue:String

Gets or sets name of excel sheet.

Implementation
public function get excelSheetValue():String
public function set excelSheetValue(value:String):void

getExcelSheetEvent

property

getExcelSheetEvent:StiGetExcelSheetEvent

Occurs when the ExcelSheet is calculated.

Implementation
public function get getExcelSheetEvent():StiGetExcelSheetEvent
public function set getExcelSheetEvent(value:StiGetExcelSheetEvent):void

gridSize

property

gridSize:Number [read-only]

Gets grid size in the unit.

Implementation
public function get gridSize():Number

growToHeight

property

growToHeight:Boolean[override]

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

height

property

height:Number[override]

Gets or sets height.

Implementation
public function get height():Number
public function set height(value:Number):void

isAutomaticDock

property

isAutomaticDock:Boolean [read-only] [override]

Gets value indicates that this is an automatic docking.

Implementation
public function get isAutomaticDock():Boolean

isPrinted

property

isPrinted:Boolean

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

largeHeight

property

largeHeight:Boolean

Gets or sets value indicates that this page has in designer large height.

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

largeHeightFactor

property

largeHeightFactor:int

Gets or sets large height factor for LargeHeight property of this page.

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

left

property

left:Number[override]

Gets or sets left margin.

Implementation
public function get left():Number
public function set left(value:Number):void

linked

property

linked:Boolean[override]

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

localizedName

property

localizedName:String [read-only] [override]

Gets a localized component name.

Implementation
public function get localizedName():String

locked

property

locked:Boolean[override]

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

lockHighlight

property

lockHighlight:Boolean

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

margins

property

margins:StiMargins

Gets or sets page margins.

Implementation
public function get margins():StiMargins
public function set margins(value:StiMargins):void

maxSize

property

maxSize:StiSize[override]

Implementation
public function get maxSize():StiSize
public function set maxSize(value:StiSize):void

minSize

property

minSize:StiSize[override]

Implementation
public function get minSize():StiSize
public function set minSize(value:StiSize):void

numberOfCopies

property

numberOfCopies:int

Gets or sets a value of number of copies of the current page.

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

offsetRectangle

property

offsetRectangle:StiRectangle

Gets or sets offset of the selected components on the page.

Implementation
public function get offsetRectangle():StiRectangle
public function set offsetRectangle(value:StiRectangle):void

orientation

property

orientation:int

Gets or sets page orientation.

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

page

property

page:StiPage[override]

Implementation
public function get page():StiPage
public function set page(value:StiPage):void

pageHeight

property

pageHeight:Number

Gets or sets the total height of the page.

Implementation
public function get pageHeight():Number
public function set pageHeight(value:Number):void

pageInfoV2

property

pageInfoV2:StiPageInfoV2 [read-only]

Implementation
public function get pageInfoV2():StiPageInfoV2

pageWidth

property

pageWidth:Number

Gets or sets the total width of the page.

Implementation
public function get pageWidth():Number
public function set pageWidth(value:Number):void

paperSize

property

paperSize:int

Gets or sets the page size.

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

paperSourceFirstPage

property

paperSourceFirstPage:int

Gets or sets the paper source for first page. Some printers does not support this feature.

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

paperSourceOfFirstPage

property

paperSourceOfFirstPage:String

Gets or sets the paper source for first page. Some printers does not support this feature.

Implementation
public function get paperSourceOfFirstPage():String
public function set paperSourceOfFirstPage(value:String):void

paperSourceOfOtherPages

property

paperSourceOfOtherPages:String

Gets or sets the paper source for other pages. Some printers does not support this feature.

Implementation
public function get paperSourceOfOtherPages():String
public function set paperSourceOfOtherPages(value:String):void

paperSourceOtherPages

property

paperSourceOtherPages:int

Gets or sets the paper source for other pages. Some printers does not support this feature.

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

parent

property

parent:StiContainer[override]

Implementation
public function get parent():StiContainer
public function set parent(value:StiContainer):void

printable

property

printable:Boolean[override]

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

printHeadersFootersFromPreviousPage

property

printHeadersFootersFromPreviousPage:Boolean

Gets or sets value which indicates that, on this page, it is necessary to print headers and footers of the previous page.

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

printOn

property

printOn:int[override]

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

printOnPreviousPage

property

printOnPreviousPage:Boolean

Gets or sets value that indicates that the page will start to be rendered on the free space of the previous page.

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

renderingEvent

property

renderingEvent:StiRenderingEvent

Occurs when a page rendering.

Implementation
public function get renderingEvent():StiRenderingEvent
public function set renderingEvent(value:StiRenderingEvent):void

report

property

report:StiReport[override]

Gets or sets the report in which the page is located.

Implementation
public function get report():StiReport
public function set report(value:StiReport):void

reportUnit

property

reportUnit:StiUnit

Used for save/load page. Internal use only.

Implementation
public function get reportUnit():StiUnit
public function set reportUnit(value:StiUnit):void

resetPageNumber

property

resetPageNumber:Boolean

Allows to reset page number on this page.

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

restrictions

property

restrictions:int[override]

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

right

property

right:Number [read-only] [override]

Gets right margin.

Implementation
public function get right():Number

segmentPerHeight

property

segmentPerHeight:int

Gets or sets the number of segments per height.

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

segmentPerWidth

property

segmentPerWidth:int

Gets or sets the number of segments per width.

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

selectedComponents

property

selectedComponents:StiArrayList [read-only]

Implementation
public function get selectedComponents():StiArrayList

selectedRectangle

property

selectedRectangle:StiRectangle

Internal use only.

Implementation
public function get selectedRectangle():StiRectangle
public function set selectedRectangle(value:StiRectangle):void

shiftMode

property

shiftMode:int[override]

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

skip

property

skip:Boolean

Gets or sets value, indicates that, when rendering of the report, this page of the report is to be skipped. Subreport component is used.

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

stopBeforePrint

property

stopBeforePrint:int

Gets or sets the page number. When it is reached then stop rendering. If the property is 0 then rendering of the report will be stopped.

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

stretchToPrintArea

property

stretchToPrintArea:Boolean

Gets or sets value, indicates that, when printing, a page stretches into print area.

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

titleBeforeHeader

property

titleBeforeHeader:Boolean

Gets or sets value, indicates that it is necessary to put the report title before the page header.

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

top

property

top:Number[override]

Gets or sets top margin.

Implementation
public function get top():Number
public function set top(value:Number):void

unit

property

unit:StiUnit [read-only]

Implementation
public function get unit():StiUnit

unlimitedBreakable

property

unlimitedBreakable:Boolean

Gets or sets value indicates that when printing of multiple-sheet cross-reports, columns and strings are to be broken.

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

unlimitedHeight

property

unlimitedHeight:Boolean

Gets or sets value, indicates that the page has an unlimited height.

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

unlimitedWidth

property

unlimitedWidth:Boolean

Gets or sets value, indicates that the page has an unlimited width.

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

useParentStyles

property

useParentStyles:Boolean[override]

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

watermark

property

watermark:StiWatermark

Gets or sets watermark of the page.

Implementation
public function get watermark():StiWatermark
public function set watermark(value:StiWatermark):void

width

property

width:Number[override]

Gets or sets width.

Implementation
public function get width():Number
public function set width(value:Number):void

zoom

property

zoom:Number [read-only]

Gets zoom of a report.

Implementation
public function get zoom():Number

Constructor Detail

StiPage

()

Constructor

public function StiPage(report:StiReport = null)

Parameters

report:StiReport (default = null)

Method Detail

clearPage

()

method

public function clearPage():void

clone

()

method

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

Parameters

... args

Returns

Object

convert

()

method

override public function convert(oldUnit:StiUnit, newUnit:StiUnit, convertComponents:Boolean = true):void

Converts a component out of one unit into another.

Parameters

	`oldUnit:StiUnit`

	`newUnit:StiUnit`

	`convertComponents:Boolean` (default = `true`)

convertFromHInches

()

method

public function convertFromHInches(unit:StiUnit, value:Number):Number

Parameters

	`unit:StiUnit`

	`value:Number`

Returns

Number

convertToHInches

()

method

public function convertToHInches(unit:StiUnit, value:Number):Number

Parameters

	`unit:StiUnit`

	`value:Number`

Returns

Number

equals

()

method

override public function equals(object:Object):Boolean

Parameters

object:Object

Returns

Boolean

getComponentsCount

()

method

public function getComponentsCount(container:StiContainer = null):int

Parameters

container:StiContainer (default = null)

Returns

int

invokeEvents

()

method

override public function invokeEvents():void

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
StiPage	Properties \| Methods

Package	stimulsoft.report.components
Class	public class StiPage
Inheritance	StiPage StiPanel StiContainer StiComponent StiBase StiService StiObject Object
Implements	IStiResetPageNumber, IStiPage
Subclasses	StiForm