Package com.stimulsoft.report.components
Class StiPage
- All Implemented Interfaces:
IStiAppExpressionCollection,IStiJsonReportObject,IStiForceSerializable,IStiSerializable,IStiSerializableRef,IStiSerializableToAttributes,IStiName,IStiBorder,IStiBreakable,IStiBrush,IStiCanGrow,IStiCanShrink,IStiComponentGuid,IStiConditions,IStiGrowToHeight,IStiInteraction,IStiPrintOn,IStiResetPageNumber,IStiSelect,IStiShift,IStiUnitConvert,IStiReportProperty,IStiIgnoryStyle,IStiInherited,IStiStateSaveRestore,Cloneable
- Direct Known Subclasses:
StiForm
Copyright Stimulsoft *
-
Field Summary
FieldsFields inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer
border, brush, collapsingIndex, components, engine, ParentComponentIsBand, ParentComponentIsCrossBand, PropertyBlockedFields inherited from class com.stimulsoft.report.components.StiComponent
canGrow, canShrink, componentPlacement, conditions, currentPointer, eventFlags, expressions, interaction, isRendered, page, parent, parentBookmark, parentPointer, PropertyComponentStyle, PropertyDelimiterComponent, PropertyDockable, PropertyInherited, PropertyLinked, PropertyLocked, PropertyMaxSize, PropertyMinSize, PropertyPlaceOnToolbox, PropertyRenderedCount, PropertyRestrictions, PropertySelectionTick, PropertyShowQuickButtons, PropertyUseParentStyles, top, widthFields inherited from class com.stimulsoft.base.services.StiService
propertiesFields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef
REFERENCE_EMPTY, REFERENCE_REPORT -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal voidclone()Creates a new object that is a copy of the current instance.clone(boolean cloneProperties, boolean cloneComponents) Creates a new object that is a copy of the current instanc * *voidConverts a component out of one unit into another * *final doubleConvertFromHInches(StiUnit unit, double value) final StiRectangleconvertToHInches(StiUnit unit, StiRectangle rect) final doubleConvertToHInches(StiUnit unit, double value) voidOccurs when when a page begins to render.doubleGets bottom margin.final StringGets or sets a cache guid of page.booleanGets or sets value which indicates whether the component can or cannot break its contents on several pages.booleangets or sets a value which indicates that this object can grow.booleangets or sets value which indicates that this object can shrink.Gets or sets the client area of a component.Occurs when start render column.Occurs when end render column.GetComponentByName(String componentName) intintGets or sets the current height of a page segment.intGets or sets the current width of a page segment.final booleanInternal use only.Gets or sets a rectangle of the component which it fills.Gets or sets a type of the component docking.final booleanOccurs when when a page ends to render.Return events collection of this component.Gets or sets an expression used for generation name of excel sheet.final StringGets or sets name of excel sheet.Occurs when the ExcelSheet is calculated.doubleGets grid size in the unit.booleangets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.getGuid()gets or sets a guid of component.doubleGets or sets height.getIcon()booleanGets value indicates that this is an automatic docking.final booleanbooleanGets or sets value indicates that this page has in designer large height.doublelarge height factor for LargeHeightAuto mode of this page.intGets or sets large height factor for LargeHeight property of this page.doublegetLeft()Gets or sets left margin.booleangets or sets a value which indicates whether the object snap to the container is turned on.Gets a localized component name.booleangets or sets a value which indicates that moving is locked.final booleanGets or sets page margins.gets or sets maximal size.gets or sets minimal size.value indicates that mirror margins are set.getName()Gets or sets a component name.intGets or sets a value of number of copies of the current page.Gets or sets offset of the selected components on the page.Gets or sets page orientation.getPage()Deprecated.doubleGets or sets the total height of the page.doubleGets or sets the total width of the page.Gets or sets the page size.Gets or sets the paper source for first page.Gets or sets the paper source for first page.Gets or sets the paper source for first page.Gets or sets the paper source for other pages.gets or sets the container in which an object is located.booleangets or sets a value which indicates whether a component is printable or not.booleanGets or sets value which indicates that, on this page, it is necessary to print headers and footers of the previous page.gets or sets a value which indicates on what pages component will be printed.booleanGets or sets value that indicates that the page will start to be rendered on the free space of the previous page.Occurs when a page rendering.Gets or sets the report in which the page is located.final StiUnitUsed for save/load page.booleanAllows to reset page number on this page.gets or sets value which indicates the restrictions of a component.doublegetRight()Gets right margin.intGets or sets the number of segments per height.intGets or sets the number of segments per width.final ArrayList<StiComponent> final StiRectangleInternal use only.gets or sets a value which indicates the shift mode of a component.booleangetSkip()Gets or sets value, indicates that, when rendering of the report, this page of the report is to be skipped.intGets or sets the page number.booleanGets or sets value, indicates that, when printing, a page stretches into print area.gets or sets tag of a component.booleanGets or sets value, indicates that it is necessary to put the report title before the page header.doublegetTop()Gets or sets top margin.getUnit()booleanGets or sets value indicates that when printing of multiple-sheet cross-reports, columns and strings are to be broken.booleanGets or sets value, indicates that the page has an unlimited height.booleanGets or sets value, indicates that the page has an unlimited width.booleangets or sets a value which indicates that this component must use styles from parent component.Gets or sets watermark of the page.doublegetWidth()Gets or sets width.doublegetZoom()Gets zoom of a report.final voidRaises the BeginRender event for this component.final voidRaises the ColumnBeginRender event for this component.final voidInvokeColumnBeginRender(Object sender, EventArgs e) Raises the ColumnBeginRender event for this component.final voidRaises the ColumnEndRender event for this component.final voidInvokeColumnEndRender(Object sender, EventArgs e) Raises the ColumnBeginRender event for this component.final voidRaises the EndRender event for this component.voidInvokes all events for this components.voidRaises the GetExcelSheet event.final voidRaises the Rendering event for this component.booleanisPage()booleanbooleanvoidLoadFromJsonObject(JSONObject jObject) final voidprotected voidRaises the BeginRender event for this component.protected voidRaises the ColumnBeginRender event for this component.protected voidRaises the ColumnEndRender event for this component.protected voidRaises the EndRender event for this component.protected voidRaises the GetExcelSheet event.protected voidRaises the Rendering event for this component.doubleprocessSnapToGrid(double width) voidvoidsetCanBreak(boolean value) voidsetCanGrow(boolean value) voidsetCanShrink(boolean value) voidsetClientRectangle(StiRectangle value) voidvoidvoidsetCurrentHeightSegment(int value) voidsetCurrentWidthSegment(int value) final voidsetDenyDrawSegmentMode(boolean value) voidsetDockStyle(StiDockStyle value) final voidsetDrillDownActivated(boolean value) voidvoidfinal voidsetExcelSheetValue(String value) voidvoidsetGrowToHeight(boolean value) voidsetHeight(double value) voidfinal voidsetIsPrinted(boolean value) voidsetLargeHeight(boolean value) voidsetLargeHeightAutoFactor(double largeHeightAutoFactor) large height factor for LargeHeightAuto mode of this page.voidsetLargeHeightFactor(int value) voidsetLeft(double value) voidsetLinked(boolean value) voidsetLocked(boolean value) final voidsetLockHighlight(boolean value) voidsetMargins(StiMargins value) voidsetMaxSize(StiSize value) voidsetMinSize(StiSize value) voidsetMirrorMargins(Boolean mirrorMargins) value indicates that mirror margins are set.voidsetNumberOfCopies(int value) voidsetOffsetRectangle(StiRectangle value) voidsetOrientation(StiPageOrientation value) voidvoidsetPageHeight(double value) voidsetPageWidth(double value) voidsetPaperSize(StiPaperKind value) voidvoidsetPaperSourceOfFirstPage(String value) voidsetPaperSourceOfOtherPages(String value) voidvoidsetParent(StiContainer value) voidsetPrintable(boolean value) voidsetPrintHeadersFootersFromPreviousPage(boolean value) voidsetPrintOn(StiPrintOnType value) voidsetPrintOnPreviousPage(boolean value) voidvoidfinal voidsetReportUnit(StiUnit value) voidsetResetPageNumber(boolean value) voidsetRestrictions(StiEnumSet<StiRestrictions> value) voidsetSegmentPerHeight(int value) voidsetSegmentPerWidth(int value) final voidsetSelectedRectangle(StiRectangle value) voidsetShiftMode(StiEnumSet<StiShiftMode> value) voidsetSkip(boolean value) voidsetSnapPageWidthToGrid(boolean snapPageWidthToGrid) voidsetStopBeforePrint(int value) voidsetStretchToPrintArea(boolean value) voidsetTitleBeforeHeader(boolean titleBeforeHeader) voidsetTop(double value) voidsetUnlimitedBreakable(boolean value) voidsetUnlimitedHeight(boolean value) voidsetUnlimitedWidth(boolean value) voidsetUseParentStyles(boolean value) voidsetWatermark(StiWatermark value) voidsetWidth(double value) booleanMethods inherited from class com.stimulsoft.report.components.complexcomponents.StiPanel
addComponent, getColumnGaps, getColumns, getColumnWidth, getColumnWidth2, getColumnWidthM, getPriority, getRightToLeft, getToolboxPosition, setColumnGaps, setColumns, setColumnWidth, setRightToLeftMethods inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer
AlignTo, AlignToGrid, AlignToGrid, Break, BringToFront, ChangePosition, checkBlockedException, CheckBlockedException, checkLargeHeight, ClearAllStates, clone, ContainerToPage, ContainerToPage, Convert, ConvertSelectedToPage, ConvertToPage, Correct, Correct, correct2, getActualSize, getActualSize, getBlocked, getBorder, GetBorder, getBrush, GetBrush, getCollapsedValue, getCollapsingIndex, getCollapsingTreePath, getComponents, GetComponents, GetComponentsList, getComponentsSelectedRectangle, getComponentStyle, getComponentType, GetConditions, getContainerInfoV1, getContainerInfoV2, GetContainerInRect, GetContainerInRect2, getDefaultClientRectangle, GetDockableComponent, GetDockStyle, GetFirstSelectableCompanent, GetFont, getHasSelected, GetHorAlignment, GetIncorrect, GetIncorrect, getIncorrect2, getLocalizedCategory, GetMaxSize, GetRectangle, GetSelectedComponents, GetSelectedComponentsWithChilds, GetSelectedRectangleWithChilds, GetTextBrush, GetTextFormat, GetTextHorAlignment, GetVertAlignment, GetWordWrap, GrowFont, InvertComponentsPosition, isForceSerializeToReport, MakeHorizontalSpacingEqual, MakeSameHeight, MakeSameSize, MakeSameWidth, MakeVerticalSpacingEqual, MoveBackward, MoveComponentsToPage, MoveForward, Normalize, OffsetLocation, OnComponentAdded, OnComponentRemoved, PageToContainer, PageToContainer, RemoveAllSelected, ResetSelection, RestoreState, saveState, SelectAll, SelectComponent, SelectInRectangle, SelectInRectangleCheckBands, SendToBack, setBlocked, setBorder, SetBorder, setBrush, SetBrush, SetCenterHorizontally, SetCenterVertically, setCollapsedValue, setCollapsingIndex, setCollapsingTreePath, setComponents, setComponentsFont, setComponentsFont, setComponentsWithSetParent, setComponentsWordWrap, SetConditions, setContainerInfoV2, SetDockStyle, setForceSerializeToReport, SetHorAlign, SetLink, setParentComponentIsBand, setParentComponentIsCrossBand, SetParentStylesToChilds, SetParentStylesToChilds, SetTextBrush, SetTextFormat, SetTextHorAlign, SetVertAlign, ShrinkFont, SortByPriorityMethods inherited from class com.stimulsoft.report.components.StiComponent
addSize, AllowPrintOn, applyConditions, canContainIn, CheckForParentComponent, clearAllStates, ClearContents, ComponentToPage, ComponentToPage, ComponentToPage, convert, decrementTop, doBookmark, DoBookmark, DockToContainer, DockToContainer, doGetBookmark, DoOffsetRect, doPointer, doPointer, fillComponentPlacement, getAfterPrintEvent, getAlias, getAllowDelete, getAnchor, getBeforePrintEvent, getBookmark, getBookmarkValue, getBuilder, getClickEvent, getComponentPlacement, GetComponentStyle, getConditions, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDoubleClickEvent, getDrillDownParameters, getEnabled, getExpressions, getForceRedrawAll, getGetBookmarkEvent, getGetDrillDownReportEvent, getGetHyperlinkEvent, getGetTagEvent, getGetToolTipEvent, getGroupHeaderBand, GetGroupHeaderBand, getHighlightState, getHyperlink, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInteraction, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLevel, getMeasureGraphics, getMouseEnterEvent, getMouseLeaveEvent, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParentBookmark, getPlaceOnToolbox, getPointer, getPointerValue, getQuickInfo, getRenderedCount, getSelectionTick, getSelectRectangle, getServiceCategory, getServiceType, getShift, getShowQuickButtons, getStates, getTag, getTagStrValue, getToolTip, getToolTipValue, incrementtTop, InternalRender, invert, InvokeAfterPrint, InvokeBeforePrint, invokeBlockly, InvokeClick, InvokeDoubleClick, InvokegetBookmark, InvokegetDrillDownReport, InvokegetHyperlink, InvokegetTag, InvokegetToolTip, InvokeMouseEnter, InvokeMouseLeave, InvokePainted, invokePainting, invokeScript, invokeScript, invokeScript, isAutomaticDock, isDesigning, isExportAsImage, IsParentSelect, NewGuid, OnAfterPrint, OnBeforePrint, OnClick, OnDoubleClick, OngetBookmark, OngetDrillDownReport, OngetHyperlink, OngetTag, OngetToolTip, OnMouseEnter, OnMouseLeave, OnPainted, OnPainting, OnRemoveComponent, packService, PageToComponent, PageToComponent, paint, PlacedOnColumnBand, Prepare, render, reset, Reset, restoreState, select, setAfterPrintEvent, setAlias, setAnchor, setBeforePrintEvent, setBookmark, setBookmarkValue, setClickEvent, setComponentPlacement, setComponentStyle, setConditions, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDoubleClickEvent, setDrillDownParameters, setEnabled, setExpressions, setGetBookmarkEvent, setGetDrillDownReportEvent, setGetHyperlinkEvent, setGetTagEvent, setGetToolTipEvent, setGuid, setHeightProp, setHighlightState, setHyperlink, setHyperlinkValue, setIgnoreNamingRule, setInherited, setInteraction, setIsRendered, setIsSelected, setLeftProp, setMouseEnterEvent, setMouseLeaveEvent, setName, setPaintRectangle, setParentBookmark, setPlaceOnToolbox, setPointer, setPointerValue, setRenderedCount, SetReportVariables, setSelectionTick, setSelectRectangle, setShift, setShowQuickButtons, setStates, setTag, setTagValue, setToolTip, setToolTipValue, setTopProp, setWidthProp, toString, UnPrepareMethods inherited from class com.stimulsoft.report.StiBase
getServiceNameMethods inherited from class com.stimulsoft.base.services.StiService
getProperties, getServiceEnabled, getServiceInfo, isPropertyPresent, MemberwiseClone, properties, setProperties, setServiceEnabledMethods inherited from class com.stimulsoft.base.serializing.StiSerializedObject
cleanReference, getReference, setReferenceMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.stimulsoft.report.components.interfaces.IStiBreakable
BreakMethods inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef
getReference, setReferenceMethods inherited from interface com.stimulsoft.report.IStiStateSaveRestore
clearAllStates, restoreState, saveState
-
Field Details
-
EMPTY_PAGE
-
margins
-
skip
public boolean skip -
segmentPerWidth
-
segmentPerHeight
-
pageInfoV2
-
drillDownPageGuid
public boolean drillDownPageGuid -
document
Internal use only. Used in the serialization of the rendered report (document) for access to the report properties. -
icon
-
handlerBeginRender
-
handlerRendering
-
handlerEndRender
-
handlerOnColumnBeginRender
-
handlerOnColumnEndRender
-
handlerOnGetExcelSheet
-
-
Constructor Details
-
StiPage
public StiPage()Creates a new component of the type StiPage. -
StiPage
Creates a new component of the type StiPage.- Parameters:
report- The report in which a page will be added.
-
-
Method Details
-
SaveToJsonObject
- Specified by:
SaveToJsonObjectin interfaceIStiJsonReportObject- Overrides:
SaveToJsonObjectin classStiPanel- Throws:
JSONException
-
LoadFromJsonObject
- Specified by:
LoadFromJsonObjectin interfaceIStiJsonReportObject- Overrides:
LoadFromJsonObjectin classStiPanel- Throws:
JSONException
-
getResetPageNumber
public boolean getResetPageNumber()Allows to reset page number on this page.- Specified by:
getResetPageNumberin interfaceIStiResetPageNumber
-
setResetPageNumber
public void setResetPageNumber(boolean value) - Specified by:
setResetPageNumberin interfaceIStiResetPageNumber
-
ConvertToHInches
-
ConvertFromHInches
-
convertToHInches
-
convert
Converts a component out of one unit into another * *- Specified by:
convertin interfaceIStiUnitConvert- Overrides:
convertin classStiContainer- Parameters:
oldUnit- Old units.newUnit- New units.
-
getCanShrink
public boolean getCanShrink()Description copied from class:StiComponentgets or sets value which indicates that this object can shrink.- Specified by:
getCanShrinkin interfaceIStiCanShrink- Overrides:
getCanShrinkin classStiComponent
-
setCanShrink
public void setCanShrink(boolean value) - Specified by:
setCanShrinkin interfaceIStiCanShrink- Overrides:
setCanShrinkin classStiComponent
-
clone
Creates a new object that is a copy of the current instanc * *- Overrides:
clonein classStiContainer- Returns:
- A new object that is a copy of this instance.
-
getCanGrow
public boolean getCanGrow()Description copied from class:StiComponentgets or sets a value which indicates that this object can grow.- Specified by:
getCanGrowin interfaceIStiCanGrow- Overrides:
getCanGrowin classStiComponent
-
setCanGrow
public void setCanGrow(boolean value) - Specified by:
setCanGrowin interfaceIStiCanGrow- Overrides:
setCanGrowin classStiComponent
-
getPrintOn
Description copied from class:StiComponentgets or sets a value which indicates on what pages component will be printed.- Specified by:
getPrintOnin interfaceIStiPrintOn- Overrides:
getPrintOnin classStiComponent
-
setPrintOn
- Specified by:
setPrintOnin interfaceIStiPrintOn- Overrides:
setPrintOnin classStiComponent
-
getCanBreak
public boolean getCanBreak()Description copied from class:StiPanelGets or sets value which indicates whether the component can or cannot break its contents on several pages.- Specified by:
getCanBreakin interfaceIStiBreakable- Overrides:
getCanBreakin classStiPanel
-
setCanBreak
public void setCanBreak(boolean value) - Specified by:
setCanBreakin interfaceIStiBreakable- Overrides:
setCanBreakin classStiPanel
-
getIsAutomaticDock
public boolean getIsAutomaticDock()Gets value indicates that this is an automatic docking. -
getDockStyle
Gets or sets a type of the component docking.- Overrides:
getDockStylein classStiComponent
-
setDockStyle
- Overrides:
setDockStylein classStiComponent
-
getMinSize
Description copied from class:StiComponentgets or sets minimal size.- Overrides:
getMinSizein classStiComponent
-
setMinSize
- Overrides:
setMinSizein classStiComponent
-
getMaxSize
Description copied from class:StiComponentgets or sets maximal size.- Overrides:
getMaxSizein classStiComponent
-
setMaxSize
- Overrides:
setMaxSizein classStiComponent
-
getLeft
public double getLeft()Gets or sets left margin.- Overrides:
getLeftin classStiComponent
-
setLeft
public void setLeft(double value) - Overrides:
setLeftin classStiComponent
-
getTop
public double getTop()Gets or sets top margin.- Overrides:
getTopin classStiComponent
-
setTop
public void setTop(double value) - Overrides:
setTopin classStiComponent
-
getWidth
public double getWidth()Gets or sets width.- Overrides:
getWidthin classStiComponent
-
setWidth
public void setWidth(double value) - Overrides:
setWidthin classStiComponent
-
getHeight
public double getHeight()Gets or sets height.- Overrides:
getHeightin classStiComponent
-
setHeight
public void setHeight(double value) - Overrides:
setHeightin classStiComponent
-
getRight
public double getRight()Gets right margin.- Overrides:
getRightin classStiComponent
-
getBottom
public double getBottom()Gets bottom margin.- Overrides:
getBottomin classStiComponent
-
getClientRectangle
Gets or sets the client area of a component.- Overrides:
getClientRectanglein classStiContainer
-
setClientRectangle
- Overrides:
setClientRectanglein classStiComponent
-
getDisplayRectangle
Gets or sets a rectangle of the component which it fills. Docking occurs in accordance to the area (Cross - components are docked by ClientRectangle).- Overrides:
getDisplayRectanglein classStiComponent
-
getDenyDrawSegmentMode
public final boolean getDenyDrawSegmentMode()Internal use only. -
setDenyDrawSegmentMode
public final void setDenyDrawSegmentMode(boolean value) -
getSelectedRectangle
Internal use only. -
setSelectedRectangle
-
getSelectedComponents
-
getUseParentStyles
public boolean getUseParentStyles()Description copied from class:StiComponentgets or sets a value which indicates that this component must use styles from parent component.- Overrides:
getUseParentStylesin classStiComponent
-
setUseParentStyles
public void setUseParentStyles(boolean value) - Overrides:
setUseParentStylesin classStiComponent
-
getGrowToHeight
public boolean getGrowToHeight()Description copied from class:StiComponentgets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.- Specified by:
getGrowToHeightin interfaceIStiGrowToHeight- Overrides:
getGrowToHeightin classStiComponent
-
setGrowToHeight
public void setGrowToHeight(boolean value) - Specified by:
setGrowToHeightin interfaceIStiGrowToHeight- Overrides:
setGrowToHeightin classStiComponent
-
getShiftMode
Description copied from class:StiComponentgets or sets a value which indicates the shift mode of a component.- Specified by:
getShiftModein interfaceIStiShift- Overrides:
getShiftModein classStiComponent
-
setShiftMode
- Specified by:
setShiftModein interfaceIStiShift- Overrides:
setShiftModein classStiComponent
-
getPrintable
public boolean getPrintable()Description copied from class:StiComponentgets or sets a value which indicates whether a component is printable or not.- Overrides:
getPrintablein classStiComponent
-
setPrintable
public void setPrintable(boolean value) - Overrides:
setPrintablein classStiComponent
-
getEvents
Return events collection of this component.- Overrides:
getEventsin classStiComponent
-
getLocalizedName
Gets a localized component name.- Overrides:
getLocalizedNamein classStiPanel
-
getPage
Deprecated.Description copied from class:StiComponentgets or sets the page on which an object is located.- Overrides:
getPagein classStiComponent
-
setPage
- Overrides:
setPagein classStiComponent
-
getParent
Description copied from class:StiComponentgets or sets the container in which an object is located.- Overrides:
getParentin classStiComponent
-
setParent
- Overrides:
setParentin classStiComponent
-
getRestrictions
Description copied from class:StiComponentgets or sets value which indicates the restrictions of a component.- Overrides:
getRestrictionsin classStiComponent
-
setRestrictions
- Overrides:
setRestrictionsin classStiComponent
-
OnBeginRender
Raises the BeginRender event for this component. -
invokeEvents
public void invokeEvents()Description copied from class:StiComponentInvokes all events for this components.- Overrides:
invokeEventsin classStiComponent
-
InvokeBeginRender
public final void InvokeBeginRender()Raises the BeginRender event for this component.- Overrides:
InvokeBeginRenderin classStiComponent
-
getBeginRenderEvent
Occurs when when a page begins to render. -
setBeginRenderEvent
-
OnRendering
Raises the Rendering event for this component. -
InvokeRendering
public final void InvokeRendering()Raises the Rendering event for this component. -
getRenderingEvent
Occurs when a page rendering. -
setRenderingEvent
-
OnEndRender
Raises the EndRender event for this component. -
InvokeEndRender
public final void InvokeEndRender()Raises the EndRender event for this component.- Overrides:
InvokeEndRenderin classStiComponent
-
getEndRenderEvent
Occurs when when a page ends to render. -
setEndRenderEvent
-
OnColumnBeginRender
Raises the ColumnBeginRender event for this component. -
InvokeColumnBeginRender
public final void InvokeColumnBeginRender()Raises the ColumnBeginRender event for this component. -
InvokeColumnBeginRender
Raises the ColumnBeginRender event for this component. -
getColumnBeginRenderEvent
Occurs when start render column. -
setColumnBeginRenderEvent
-
OnColumnEndRender
Raises the ColumnEndRender event for this component. -
InvokeColumnEndRender
public final void InvokeColumnEndRender()Raises the ColumnEndRender event for this component. -
InvokeColumnEndRender
Raises the ColumnBeginRender event for this component. -
getColumnEndRenderEvent
Occurs when end render column. -
setColumnEndRenderEvent
-
OnGetExcelSheet
Raises the GetExcelSheet event. -
InvokeGetExcelSheet
Raises the GetExcelSheet event. -
getGetExcelSheetEvent
Occurs when the ExcelSheet is calculated. -
setGetExcelSheetEvent
-
getExcelSheetValue
Gets or sets name of excel sheet. -
setExcelSheetValue
-
getExcelSheet
Gets or sets an expression used for generation name of excel sheet. -
setExcelSheet
-
getIsPrinted
public final boolean getIsPrinted() -
setIsPrinted
public final void setIsPrinted(boolean value) -
getZoom
public double getZoom()Gets zoom of a report. -
getGridSize
public double getGridSize()Gets grid size in the unit. -
getPrintOnPreviousPage
public boolean getPrintOnPreviousPage()Gets or sets value that indicates that the page will start to be rendered on the free space of the previous page. -
setPrintOnPreviousPage
public void setPrintOnPreviousPage(boolean value) -
getPaperSize
Gets or sets the page size. -
setPaperSize
-
getPaperSourceFirstPage
Gets or sets the paper source for first page. Some printers does not support this feature. -
setPaperSourceFirstPage
-
getPaperSourceOfFirstPage
Gets or sets the paper source for first page. Some printers does not support this feature. -
setPaperSourceOfFirstPage
-
getPaperSourceOtherPages
Gets or sets the paper source for other pages. Some printers does not support this feature. -
setPaperSourceOtherPages
-
getPaperSourceOfOtherPages
Gets or sets the paper source for first page. Some printers does not support this feature. -
setPaperSourceOfOtherPages
-
getNumberOfCopies
public int getNumberOfCopies()Gets or sets a value of number of copies of the current page. -
setNumberOfCopies
public void setNumberOfCopies(int value) -
getUnlimitedBreakable
public boolean getUnlimitedBreakable()Gets or sets value indicates that when printing of multiple-sheet cross-reports, columns and strings are to be broken. -
setUnlimitedBreakable
public void setUnlimitedBreakable(boolean value) -
getLargeHeight
public boolean getLargeHeight()Gets or sets value indicates that this page has in designer large height. -
setLargeHeight
public void setLargeHeight(boolean value) -
getLargeHeightFactor
public int getLargeHeightFactor()Gets or sets large height factor for LargeHeight property of this page. -
setLargeHeightFactor
public void setLargeHeightFactor(int value) -
getCurrentWidthSegment
public int getCurrentWidthSegment()Gets or sets the current width of a page segment. -
setCurrentWidthSegment
public void setCurrentWidthSegment(int value) -
getCurrentHeightSegment
public int getCurrentHeightSegment()Gets or sets the current height of a page segment. -
setCurrentHeightSegment
public void setCurrentHeightSegment(int value) -
getStopBeforePrint
public int getStopBeforePrint()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. -
setStopBeforePrint
public void setStopBeforePrint(int value) -
getSkip
public boolean getSkip()Gets or sets value, indicates that, when rendering of the report, this page of the report is to be skipped. Subreport component is used. -
setSkip
public void setSkip(boolean value) -
getStretchToPrintArea
public boolean getStretchToPrintArea()Gets or sets value, indicates that, when printing, a page stretches into print area. -
setStretchToPrintArea
public void setStretchToPrintArea(boolean value) -
getTitleBeforeHeader
public boolean getTitleBeforeHeader()Gets or sets value, indicates that it is necessary to put the report title before the page header. -
setTitleBeforeHeader
public void setTitleBeforeHeader(boolean titleBeforeHeader) -
getUnlimitedHeight
public boolean getUnlimitedHeight()Gets or sets value, indicates that the page has an unlimited height. -
setUnlimitedHeight
public void setUnlimitedHeight(boolean value) -
getUnlimitedWidth
public boolean getUnlimitedWidth()Gets or sets value, indicates that the page has an unlimited width. -
setUnlimitedWidth
public void setUnlimitedWidth(boolean value) -
getOffsetRectangle
Gets or sets offset of the selected components on the page. -
setOffsetRectangle
-
getOrientation
Gets or sets page orientation. -
setOrientation
-
getLocked
public boolean getLocked()Description copied from class:StiComponentgets or sets a value which indicates that moving is locked.- Overrides:
getLockedin classStiComponent
-
setLocked
public void setLocked(boolean value) - Overrides:
setLockedin classStiComponent
-
getLinked
public boolean getLinked()Description copied from class:StiComponentgets or sets a value which indicates whether the object snap to the container is turned on.- Overrides:
getLinkedin classStiComponent
-
setLinked
public void setLinked(boolean value) - Overrides:
setLinkedin classStiComponent
-
getPageWidth
public double getPageWidth()Gets or sets the total width of the page. -
setPageWidth
public void setPageWidth(double value) -
getPageHeight
public double getPageHeight()Gets or sets the total height of the page. -
setPageHeight
public void setPageHeight(double value) -
getSegmentPerWidth
public int getSegmentPerWidth()Gets or sets the number of segments per width. -
setSegmentPerWidth
public void setSegmentPerWidth(int value) -
getSegmentPerHeight
public int getSegmentPerHeight()Gets or sets the number of segments per height. -
setSegmentPerHeight
public void setSegmentPerHeight(int value) -
getWatermark
Gets or sets watermark of the page. -
setWatermark
-
getMargins
Gets or sets page margins. -
setMargins
-
getReport
Gets or sets the report in which the page is located.- Specified by:
getReportin interfaceIStiReportProperty- Overrides:
getReportin classStiComponent
-
setReport
- Overrides:
setReportin classStiComponent
-
getUnit
-
getReportUnit
Used for save/load page. Internal use only. -
setReportUnit
-
getLockHighlight
public final boolean getLockHighlight() -
setLockHighlight
public final void setLockHighlight(boolean value) -
getDrillDownActivated
public final boolean getDrillDownActivated() -
setDrillDownActivated
public final void setDrillDownActivated(boolean value) -
getCacheGuid
Gets or sets a cache guid of page. -
NewCacheGuid
public final void NewCacheGuid() -
ClearPage
public final void ClearPage() -
GetComponentsCount
public int GetComponentsCount()- Overrides:
GetComponentsCountin classStiContainer
-
getEngineVersion
-
TitleBeforeHeader
public boolean TitleBeforeHeader() -
getComponentPlacementForChildren
- Overrides:
getComponentPlacementForChildrenin classStiContainer
-
clone
Description copied from class:StiComponentCreates a new object that is a copy of the current instance.- Overrides:
clonein classStiComponent- Returns:
- A new object that is a copy of this instance.
-
getPageInfoV2
-
getName
Description copied from class:StiBaseGets or sets a component name.- Specified by:
getNamein interfaceIStiName- Overrides:
getNamein classStiContainer
-
getGuid
Description copied from class:StiComponentgets or sets a guid of component.- Specified by:
getGuidin interfaceIStiComponentGuid- Overrides:
getGuidin classStiContainer
-
getTagValue
Description copied from class:StiComponentgets or sets tag of a component.- Overrides:
getTagValuein classStiContainer
-
getIcon
- Returns:
- the icon
-
setIcon
- Parameters:
icon- the icon to set
-
getLargeHeightAutoFactor
public double getLargeHeightAutoFactor()large height factor for LargeHeightAuto mode of this page.- Returns:
- the largeHeightAutoFactor
-
setLargeHeightAutoFactor
public void setLargeHeightAutoFactor(double largeHeightAutoFactor) large height factor for LargeHeightAuto mode of this page.- Parameters:
largeHeightAutoFactor- the largeHeightAutoFactor to set
-
getMirrorMargins
value indicates that mirror margins are set.- Returns:
- the mirrorMargins
-
setMirrorMargins
value indicates that mirror margins are set.- Parameters:
mirrorMargins- the mirrorMargins to set
-
isPage
public boolean isPage() -
disposeImagesAndClearComponents
public void disposeImagesAndClearComponents() -
processSnapToGrid
public double processSnapToGrid(double width) -
IsSnapPageWidthToGrid
public boolean IsSnapPageWidthToGrid() -
GetComponentByName
-
isSnapPageWidthToGrid
public boolean isSnapPageWidthToGrid() -
setSnapPageWidthToGrid
public void setSnapPageWidthToGrid(boolean snapPageWidthToGrid)
-