Package com.stimulsoft.report.dialogs

Class StiForm

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.base.services.StiService

com.stimulsoft.report.StiBase

com.stimulsoft.report.components.StiComponent

com.stimulsoft.report.components.complexcomponents.StiContainer

com.stimulsoft.report.components.complexcomponents.StiPanel

com.stimulsoft.report.components.StiPage

com.stimulsoft.report.dialogs.StiForm

All Implemented Interfaces:

IStiAppExpressionCollection, IStiJsonReportObject, IStiForceSerializable, IStiSerializable, IStiSerializableRef, IStiSerializableToAttributes, IStiName, IStiBorder, IStiBreakable, IStiBrush, IStiCanGrow, IStiCanShrink, IStiComponentGuid, IStiConditions, IStiGrowToHeight, IStiInteraction, IStiPrintOn, IStiResetPageNumber, IStiSelect, IStiShift, IStiUnitConvert, IStiForm, IStiReportProperty, IStiIgnoryStyle, IStiInherited, IStiStateSaveRestore, Cloneable

public class StiForm
extends StiPage
implements IStiForm

Represents a dialog box.

Field Summary

Fields inherited from class com.stimulsoft.report.components.StiPage

document, drillDownPageGuid, EMPTY_PAGE, handlerBeginRender, handlerEndRender, handlerOnColumnBeginRender, handlerOnColumnEndRender, handlerOnGetExcelSheet, handlerRendering, icon, margins, pageInfoV2, segmentPerHeight, segmentPerWidth, skip

Fields inherited from class com.stimulsoft.report.components.complexcomponents.StiContainer

border, brush, collapsingIndex, components, engine, ParentComponentIsBand, ParentComponentIsCrossBand, PropertyBlocked

Fields 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, width

Fields inherited from class com.stimulsoft.base.services.StiService

properties

Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor	Description
StiForm()	Creates a new StiForm.
StiForm(StiReport report)	Creates a new StiForm.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Creates a new object that is a copy of the current instance.
void	convert(StiUnit oldUnit, StiUnit newUnit)	Converts a component out of one unit into another * *
final StiAfterPrintEvent	getAfterPrintEvent()	Occurs after the component printing.
StiColor	getBackColor()	Gets or sets the background color for the control.
final StiBeforePrintEvent	getBeforePrintEvent()	Occurs before printing of the component.
final StiBeginRenderEvent	getBeginRenderEvent()	Occurs when when a page begins to render.
final StiBookmarkExpression	getBookmark()	gets or sets the expression to fill a component bookmark.
StiBorder	getBorder()	Gets or sets frame of the component.
StiBrush	getBrush()	Gets or sets a brush to fill a component.
boolean	getCanBreak()	Gets or sets value which indicates whether the component can or cannot break its contents on several pages.
final boolean	getCanGrow()	gets or sets a value which indicates that this object can grow.
final boolean	getCanShrink()	gets or sets value which indicates that this object can shrink.
StiClickEvent	getClickEvent()	Gets or sets a script of the event Click.
StiClosedFormEvent	getClosedFormEvent()	Gets or sets a script of the event ClosedForm.
StiClosingFormEvent	getClosingFormEvent()	Gets or sets a script of the event ClosingForm.
final StiColumnBeginRenderEvent	getColumnBeginRenderEvent()	Occurs when start render column.
final StiColumnEndRenderEvent	getColumnEndRenderEvent()	Occurs when end render column.
final double	getColumnGaps()	Gets or sets distance between two columns.
final int	getColumns()	Gets or sets columns count.
final double	getColumnWidth()	Gets or sets width of column.
String	getComponentStyle()	gets or sets a style of a component.
final StiConditionsCollection	getConditions()	gets or sets the collection of conditions.
final Object	getControlWpf()	Gets ot sets WPF control for this Report Control.
final int	getDialogResult()	Gets or sets the dialog result for the form.
final boolean	getEnabled()	gets or sets a value which indicates will this component be available or not.
final StiEndRenderEvent	getEndRenderEvent()	Occurs when when a page ends to render.
StiEventsCollection	getEvents()	Return events collection of this component;
final StiExcelSheetExpression	getExcelSheet()	Gets or sets an expression used for generation name of excel sheet.
StiFont	getFont()	Gets or sets font of control.
final StiGetBookmarkEvent	getGetBookmarkEvent()	Occurs when getting of the Bookmark for the component.
final StiGetDrillDownReportEvent	getGetDrillDownReportEvent()	Occurs when it is required to get a report for the Drill-Down operation.
final StiGetExcelSheetEvent	getGetExcelSheetEvent()	Occurs when the ExcelSheet is calculated.
final StiGetHyperlinkEvent	getGetHyperlinkEvent()	Occurs when getting Hyperlink for the component.
StiGetTagEvent	getGetTagEvent()	Occurs when getting a Tag for a component.
final StiGetToolTipEvent	getGetToolTipEvent()	Occurs when getting the ToolTip for the component.
double	getGridSize()	Gets grid size in the unit.
final double	getHeight()	Gets or sets height.
final StiHyperlinkExpression	getHyperlink()	gets or sets an expression to fill a component hyperlink.
StiInteraction	getInteraction()	gets interaction options of this component.
final boolean	getLargeHeight()	Gets or sets value indicates that this page has in designer large height.
final int	getLargeHeightFactor()	Gets or sets large height factor for LargeHeight property of this page.
final double	getLeft()	Gets or sets left margin.
StiLoadFormEvent	getLoadFormEvent()	Gets or sets a script of the event LoadForm.
String	getLocalizedName()	Gets a localized component name.
final StiPoint	getLocation()	Gets or sets the coordinates of the upper-left corner of the form.
final StiMargins	getMargins()	Gets or sets page margins.
final StiMouseEnterEvent	getMouseEnterEvent()	Occurs when user enters the mouse into the area of the component in the window of viewer.
final StiMouseLeaveEvent	getMouseLeaveEvent()	Occurs when user leaves the mouse out of the area of the component in the window of viewer.
int	getNumberOfCopies()	Gets or sets a value of number of copies of the current page.
final StiPageOrientation	getOrientation()	Gets or sets page orientation.
final double	getPageHeight()	Gets or sets the total height of the page.
final double	getPageWidth()	Gets or sets the total width of the page.
StiPaperKind	getPaperSize()	Gets or sets the page size.
StiPaperSourceKind	getPaperSourceFirstPage()	Gets or sets the paper source for first page.
String	getPaperSourceOfFirstPage()	Gets or sets the paper source for first page.
String	getPaperSourceOfOtherPages()	Gets or sets the paper source for first page.
StiPaperSourceKind	getPaperSourceOtherPages()	Gets or sets the paper source for other pages.
final boolean	getPrintable()	gets or sets a value which indicates whether a component is printable or not.
final boolean	getPrintHeadersFootersFromPreviousPage()	Gets or sets value which indicates that, on this page, it is necessary to print headers and footers of the previous page.
StiPrintOnType	getPrintOn()	gets or sets a value which indicates on what pages component will be printed.
final boolean	getPrintOnPreviousPage()	Gets or sets value that indicates that the page will start to be rendered on the free space of the previous page.
final StiRenderingEvent	getRenderingEvent()	Occurs when a page rendering.
final boolean	getResetPageNumber()	Allows to reset page number on this page.
final int	getSegmentPerHeight()	Gets or sets the number of segments per height.
final int	getSegmentPerWidth()	Gets or sets the number of segments per width.
String	getServiceCategory()	Gets a service category.
final StiSize	getSize()	Gets or sets the size of the form.
final boolean	getSkip()	Gets or sets value, indicates that, when rendering of the report, this page of the report is to be skipped.
final int	getStopBeforePrint()	Gets or sets the page number.
final boolean	getStretchToPrintArea()	Gets or sets value, indicates that, when printing, a page stretches into print area.
StiTagExpression	getTag()	gets or sets the expression to fill a component tag.
String	getText()	Gets or sets the text associated with this control.
final boolean	getTitleBeforeHeader()	Gets or sets value, indicates that it is necessary to put the report title before the page header.
final StiToolTipExpression	getToolTip()	gets or sets the expression to fill a component tooltip.
final double	getTop()	Gets or sets top margin.
StiUnit	getUnit()
final boolean	getUnlimitedBreakable()	Gets or sets value indicates that when printing of multiple-sheet cross-reports, columns and strings are to be broken.
final boolean	getUnlimitedHeight()	Gets or sets value, indicates that the page has an unlimited height.
final boolean	getUnlimitedWidth()	Gets or sets value, indicates that the page has an unlimited width.
boolean	getUseParentStyles()	gets or sets a value which indicates that this component must use styles from parent component.
boolean	getVisible()	Gets or sets a value indicating whether the control is displayed.
final StiWatermark	getWatermark()	Gets or sets watermark of the page.
final double	getWidth()	Gets or sets width.
double	getZoom()	Gets zoom of a report.
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
final void	setAfterPrintEvent(StiAfterPrintEvent value)
void	setBackColor(StiColor value)
final void	setBeforePrintEvent(StiBeforePrintEvent value)
final void	setBeginRenderEvent(StiBeginRenderEvent value)
final void	setBookmark(StiBookmarkExpression value)
void	setBorder(StiBorder value)
void	setBrush(StiBrush value)
void	setCanBreak(boolean value)
final void	setCanGrow(boolean value)
final void	setCanShrink(boolean value)
void	setClickEvent(StiClickEvent value)
void	setClosedFormEvent(StiClosedFormEvent value)
void	setClosingFormEvent(StiClosingFormEvent value)
final void	setColumnBeginRenderEvent(StiColumnBeginRenderEvent value)
final void	setColumnEndRenderEvent(StiColumnEndRenderEvent value)
final void	setColumnGaps(double value)
final void	setColumns(int value)
final void	setColumnWidth(double value)
void	setComponentStyle(String value)
final void	setConditions(StiConditionsCollection value)
final void	setControlWpf(Object value)
final void	setDialogResult(int value)
final void	setEnabled(boolean value)
final void	setEndRenderEvent(StiEndRenderEvent value)
final void	setExcelSheet(StiExcelSheetExpression value)
void	setFont(StiFont value)
final void	setGetBookmarkEvent(StiGetBookmarkEvent value)
final void	setGetDrillDownReportEvent(StiGetDrillDownReportEvent value)
final void	setGetExcelSheetEvent(StiGetExcelSheetEvent value)
final void	setGetHyperlinkEvent(StiGetHyperlinkEvent value)
void	setGetTagEvent(StiGetTagEvent value)
final void	setGetToolTipEvent(StiGetToolTipEvent value)
final void	setHeight(int value)
final void	setHyperlink(StiHyperlinkExpression value)
void	setInteraction(StiInteraction value)
final void	setLargeHeight(boolean value)
final void	setLargeHeightFactor(int value)
final void	setLeft(int value)
void	setLoadFormEvent(StiLoadFormEvent value)
final void	setLocation(StiPoint value)
final void	setMargins(StiMargins value)
final void	setMouseEnterEvent(StiMouseEnterEvent value)
final void	setMouseLeaveEvent(StiMouseLeaveEvent value)
void	setNumberOfCopies(int value)
final void	setOrientation(StiPageOrientation value)
final void	setPageHeight(double value)
final void	setPageWidth(double value)
void	setPaperSize(StiPaperKind value)
void	setPaperSourceFirstPage(StiPaperSourceKind value)
void	setPaperSourceOfFirstPage(String value)
void	setPaperSourceOfOtherPages(String value)
void	setPaperSourceOtherPages(StiPaperSourceKind value)
final void	setPrintable(boolean value)
final void	setPrintHeadersFootersFromPreviousPage(boolean value)
void	setPrintOn(StiPrintOnType value)
final void	setPrintOnPreviousPage(boolean value)
final void	setRenderingEvent(StiRenderingEvent value)
final void	setResetPageNumber(boolean value)
final void	setSegmentPerHeight(int value)
final void	setSegmentPerWidth(int value)
final void	setSize(StiSize value)
final void	setSkip(boolean value)
final void	setStopBeforePrint(int value)
final void	setStretchToPrintArea(boolean value)
void	setTag(StiTagExpression value)
void	setText(String value)
final void	setToolTip(StiToolTipExpression value)
final void	setTop(int value)
final void	setUnlimitedBreakable(boolean value)
final void	setUnlimitedHeight(boolean value)
final void	setUnlimitedWidth(boolean value)
void	setUseParentStyles(boolean value)
void	setVisible(boolean value)
final void	setWatermark(StiWatermark value)
final void	setWidth(int value)
protected final void	updateReportControl(String propertyName)	Use for update report control properties.

Methods inherited from class com.stimulsoft.report.components.StiPage

ClearPage, clone, ConvertFromHInches, convertToHInches, ConvertToHInches, disposeImagesAndClearComponents, getBottom, getCacheGuid, getClientRectangle, GetComponentByName, getComponentPlacementForChildren, GetComponentsCount, getCurrentHeightSegment, getCurrentWidthSegment, getDenyDrawSegmentMode, getDisplayRectangle, getDockStyle, getDrillDownActivated, getEngineVersion, getExcelSheetValue, getGrowToHeight, getGuid, getIcon, getIsAutomaticDock, getIsPrinted, getLargeHeightAutoFactor, getLinked, getLocked, getLockHighlight, getMaxSize, getMinSize, getMirrorMargins, getName, getOffsetRectangle, getPage, getPageInfoV2, getParent, getReport, getReportUnit, getRestrictions, getRight, getSelectedComponents, getSelectedRectangle, getShiftMode, getTagValue, InvokeBeginRender, InvokeColumnBeginRender, InvokeColumnBeginRender, InvokeColumnEndRender, InvokeColumnEndRender, InvokeEndRender, invokeEvents, InvokeGetExcelSheet, InvokeRendering, isPage, isSnapPageWidthToGrid, IsSnapPageWidthToGrid, NewCacheGuid, OnBeginRender, OnColumnBeginRender, OnColumnEndRender, OnEndRender, OnGetExcelSheet, OnRendering, processSnapToGrid, setClientRectangle, setCurrentHeightSegment, setCurrentWidthSegment, setDenyDrawSegmentMode, setDockStyle, setDrillDownActivated, setExcelSheetValue, setGrowToHeight, setHeight, setIcon, setIsPrinted, setLargeHeightAutoFactor, setLeft, setLinked, setLocked, setLockHighlight, setMaxSize, setMinSize, setMirrorMargins, setOffsetRectangle, setPage, setParent, setReport, setReportUnit, setRestrictions, setSelectedRectangle, setShiftMode, setSnapPageWidthToGrid, setTitleBeforeHeader, setTop, setWidth, TitleBeforeHeader

Methods inherited from class com.stimulsoft.report.components.complexcomponents.StiPanel

addComponent, getColumnWidth2, getColumnWidthM, getPriority, getRightToLeft, getToolboxPosition, setRightToLeft

Methods 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, GetBrush, getCollapsedValue, getCollapsingIndex, getCollapsingTreePath, getComponents, GetComponents, GetComponentsList, getComponentsSelectedRectangle, 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, 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, SortByPriority

Methods 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, getAlias, getAllowDelete, getAnchor, getBookmarkValue, getBuilder, getComponentPlacement, GetComponentStyle, getContainer, getCurrentBookmark, getDataBand, GetDataBand, getDelimiterComponent, getDisplayRectangle1, getDockable, getDockRegion, getDockRegion, getDoubleClickEvent, getDrillDownParameters, getExpressions, getForceRedrawAll, getGroupHeaderBand, GetGroupHeaderBand, getHighlightState, getHyperlinkValue, getIgnoreNamingRule, getImage, getImage, getInherited, getInvalidateOnMouseOver, getIsCross, getIsDesigning, getIsEnabled, getIsEventEmpty, getIsExporting, getIsgetTagHandlerEmpty, getIsPrinting, getIsRendered, getIsSelected, getLevel, getMeasureGraphics, getPaintRectangle, getPaintRectangle, getPaintRectangle, getParentBookmark, getPlaceOnToolbox, getPointer, getPointerValue, getQuickInfo, getRenderedCount, getSelectionTick, getSelectRectangle, getServiceType, getShift, getShowQuickButtons, getStates, getTagStrValue, 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, setAlias, setAnchor, setBookmarkValue, setComponentPlacement, setCurrentBookmark, setDelimiterComponent, setDirectDisplayRectangle, setDisplayRectangle, setDockable, setDoubleClickEvent, setDrillDownParameters, setExpressions, setGuid, setHeightProp, setHighlightState, setHyperlinkValue, setIgnoreNamingRule, setInherited, setIsRendered, setIsSelected, setLeftProp, setName, setPaintRectangle, setParentBookmark, setPlaceOnToolbox, setPointer, setPointerValue, setRenderedCount, SetReportVariables, setSelectionTick, setSelectRectangle, setShift, setShowQuickButtons, setStates, setTagValue, setToolTipValue, setTopProp, setWidthProp, toString, UnPrepare

Methods inherited from class com.stimulsoft.report.StiBase

getServiceName

Methods inherited from class com.stimulsoft.base.services.StiService

getProperties, getServiceEnabled, getServiceInfo, isPropertyPresent, MemberwiseClone, properties, setProperties, setServiceEnabled

Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject

cleanReference, getReference, setReference

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stimulsoft.report.components.interfaces.IStiBreakable

Break

Methods inherited from interface com.stimulsoft.report.dialogs.IStiForm

getName, setName

Methods inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

getReference, setReference

Methods inherited from interface com.stimulsoft.report.IStiStateSaveRestore

clearAllStates, restoreState, saveState

Constructor Details

StiForm

public StiForm()

Creates a new StiForm.

StiForm

public StiForm(StiReport report)

Creates a new StiForm.

Parameters:

rect - The rectangle describes sizes and position of the control.

Method Details

getServiceCategory

public String getServiceCategory()

Gets a service category.

Overrides:

getServiceCategory in class StiComponent

clone

public Object clone()

Creates a new object that is a copy of the current instance.

Overrides:

clone in class StiPage

Returns:

A new object that is a copy of this instance.

getEvents

public StiEventsCollection getEvents()

Return events collection of this component;

Overrides:

getEvents in class StiPage

getLocalizedName

public String getLocalizedName()

Gets a localized component name.

Overrides:

getLocalizedName in class StiPage

getMargins

public final StiMargins getMargins()

Description copied from class: StiPage

Gets or sets page margins.

Overrides:

getMargins in class StiPage

setMargins

public final void setMargins(StiMargins value)

Overrides:

setMargins in class StiPage

getPrintHeadersFootersFromPreviousPage

public final boolean getPrintHeadersFootersFromPreviousPage()

Description copied from class: StiPage

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

Overrides:

getPrintHeadersFootersFromPreviousPage in class StiPage

setPrintHeadersFootersFromPreviousPage

public final void setPrintHeadersFootersFromPreviousPage(boolean value)

Overrides:

setPrintHeadersFootersFromPreviousPage in class StiPage

getPrintOnPreviousPage

public final boolean getPrintOnPreviousPage()

Description copied from class: StiPage

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

Overrides:

getPrintOnPreviousPage in class StiPage

setPrintOnPreviousPage

public final void setPrintOnPreviousPage(boolean value)

Overrides:

setPrintOnPreviousPage in class StiPage

getStopBeforePrint

public final int getStopBeforePrint()

Description copied from class: StiPage

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.

Overrides:

getStopBeforePrint in class StiPage

setStopBeforePrint

public final void setStopBeforePrint(int value)

Overrides:

setStopBeforePrint in class StiPage

getLargeHeight

public final boolean getLargeHeight()

Description copied from class: StiPage

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

Overrides:

getLargeHeight in class StiPage

setLargeHeight

public final void setLargeHeight(boolean value)

Overrides:

setLargeHeight in class StiPage

getLargeHeightFactor

public final int getLargeHeightFactor()

Description copied from class: StiPage

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

Overrides:

getLargeHeightFactor in class StiPage

setLargeHeightFactor

public final void setLargeHeightFactor(int value)

Overrides:

setLargeHeightFactor in class StiPage

getResetPageNumber

public final boolean getResetPageNumber()

Description copied from class: StiPage

Allows to reset page number on this page.

Specified by:

getResetPageNumber in interface IStiResetPageNumber

Overrides:

getResetPageNumber in class StiPage

setResetPageNumber

public final void setResetPageNumber(boolean value)

Specified by:

setResetPageNumber in interface IStiResetPageNumber

Overrides:

setResetPageNumber in class StiPage

getWatermark

public final StiWatermark getWatermark()

Description copied from class: StiPage

Gets or sets watermark of the page.

Overrides:

getWatermark in class StiPage

setWatermark

public final void setWatermark(StiWatermark value)

Overrides:

setWatermark in class StiPage

getExcelSheet

public final StiExcelSheetExpression getExcelSheet()

Description copied from class: StiPage

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

Overrides:

getExcelSheet in class StiPage

setExcelSheet

public final void setExcelSheet(StiExcelSheetExpression value)

Overrides:

setExcelSheet in class StiPage

getZoom

public double getZoom()

Description copied from class: StiPage

Gets zoom of a report.

Overrides:

getZoom in class StiPage

getGridSize

public double getGridSize()

Description copied from class: StiPage

Gets grid size in the unit.

Overrides:

getGridSize in class StiPage

getUnit

public StiUnit getUnit()

Overrides:

getUnit in class StiPage

getCanBreak

public boolean getCanBreak()

Description copied from class: StiPanel

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

Specified by:

getCanBreak in interface IStiBreakable

Overrides:

getCanBreak in class StiPage

setCanBreak

public void setCanBreak(boolean value)

Specified by:

setCanBreak in interface IStiBreakable

Overrides:

setCanBreak in class StiPage

getInteraction

public StiInteraction getInteraction()

Description copied from class: StiComponent

gets interaction options of this component.

Specified by:

getInteraction in interface IStiInteraction

Overrides:

getInteraction in class StiComponent

setInteraction

public void setInteraction(StiInteraction value)

Specified by:

setInteraction in interface IStiInteraction

Overrides:

setInteraction in class StiComponent

getPaperSourceFirstPage

public StiPaperSourceKind getPaperSourceFirstPage()

Description copied from class: StiPage

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

Overrides:

getPaperSourceFirstPage in class StiPage

setPaperSourceFirstPage

public void setPaperSourceFirstPage(StiPaperSourceKind value)

Overrides:

setPaperSourceFirstPage in class StiPage

getPaperSourceOfFirstPage

public String getPaperSourceOfFirstPage()

Description copied from class: StiPage

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

Overrides:

getPaperSourceOfFirstPage in class StiPage

setPaperSourceOfFirstPage

public void setPaperSourceOfFirstPage(String value)

Overrides:

setPaperSourceOfFirstPage in class StiPage

getPaperSourceOtherPages

public StiPaperSourceKind getPaperSourceOtherPages()

Description copied from class: StiPage

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

Overrides:

getPaperSourceOtherPages in class StiPage

setPaperSourceOtherPages

public void setPaperSourceOtherPages(StiPaperSourceKind value)

Overrides:

setPaperSourceOtherPages in class StiPage

getPaperSourceOfOtherPages

public String getPaperSourceOfOtherPages()

Description copied from class: StiPage

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

Overrides:

getPaperSourceOfOtherPages in class StiPage

setPaperSourceOfOtherPages

public void setPaperSourceOfOtherPages(String value)

Overrides:

setPaperSourceOfOtherPages in class StiPage

getUseParentStyles

public boolean getUseParentStyles()

Description copied from class: StiComponent

gets or sets a value which indicates that this component must use styles from parent component.

Overrides:

getUseParentStyles in class StiPage

setUseParentStyles

public void setUseParentStyles(boolean value)

Overrides:

setUseParentStyles in class StiPage

getConditions

public final StiConditionsCollection getConditions()

Description copied from class: StiComponent

gets or sets the collection of conditions.

Specified by:

getConditions in interface IStiConditions

Overrides:

getConditions in class StiComponent

setConditions

public final void setConditions(StiConditionsCollection value)

Specified by:

setConditions in interface IStiConditions

Overrides:

setConditions in class StiComponent

getComponentStyle

public String getComponentStyle()

Description copied from class: StiComponent

gets or sets a style of a component.

Overrides:

getComponentStyle in class StiContainer

setComponentStyle

public void setComponentStyle(String value)

Overrides:

setComponentStyle in class StiComponent

getPaperSize

public StiPaperKind getPaperSize()

Description copied from class: StiPage

Gets or sets the page size.

Overrides:

getPaperSize in class StiPage

setPaperSize

public void setPaperSize(StiPaperKind value)

Overrides:

setPaperSize in class StiPage

getNumberOfCopies

public int getNumberOfCopies()

Description copied from class: StiPage

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

Overrides:

getNumberOfCopies in class StiPage

setNumberOfCopies

public void setNumberOfCopies(int value)

Overrides:

setNumberOfCopies in class StiPage

getPrintOn

public StiPrintOnType getPrintOn()

Description copied from class: StiComponent

gets or sets a value which indicates on what pages component will be printed.

Specified by:

getPrintOn in interface IStiPrintOn

Overrides:

getPrintOn in class StiPage

setPrintOn

public void setPrintOn(StiPrintOnType value)

Specified by:

setPrintOn in interface IStiPrintOn

Overrides:

setPrintOn in class StiPage

getBorder

public StiBorder getBorder()

Description copied from class: StiContainer

Gets or sets frame of the component.

Specified by:

getBorder in interface IStiBorder

Overrides:

getBorder in class StiContainer

setBorder

public void setBorder(StiBorder value)

Specified by:

setBorder in interface IStiBorder

Overrides:

setBorder in class StiContainer

getBrush

public StiBrush getBrush()

Description copied from class: StiContainer

Gets or sets a brush to fill a component.

Specified by:

getBrush in interface IStiBrush

Overrides:

getBrush in class StiContainer

setBrush

public void setBrush(StiBrush value)

Specified by:

setBrush in interface IStiBrush

Overrides:

setBrush in class StiContainer

convert

public void convert(StiUnit oldUnit,
 StiUnit newUnit)

Description copied from class: StiPage

Converts a component out of one unit into another * *

Specified by:

convert in interface IStiUnitConvert

Overrides:

convert in class StiPage

Parameters:

oldUnit - Old units.

newUnit - New units.

getUnlimitedBreakable

public final boolean getUnlimitedBreakable()

Description copied from class: StiPage

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

Overrides:

getUnlimitedBreakable in class StiPage

setUnlimitedBreakable

public final void setUnlimitedBreakable(boolean value)

Overrides:

setUnlimitedBreakable in class StiPage

getSkip

public final boolean getSkip()

Description copied from class: StiPage

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

Overrides:

getSkip in class StiPage

setSkip

public final void setSkip(boolean value)

Overrides:

setSkip in class StiPage

getStretchToPrintArea

public final boolean getStretchToPrintArea()

Description copied from class: StiPage

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

Overrides:

getStretchToPrintArea in class StiPage

setStretchToPrintArea

public final void setStretchToPrintArea(boolean value)

Overrides:

setStretchToPrintArea in class StiPage

getTitleBeforeHeader

public final boolean getTitleBeforeHeader()

Description copied from class: StiPage

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

Overrides:

getTitleBeforeHeader in class StiPage

getUnlimitedHeight

public final boolean getUnlimitedHeight()

Description copied from class: StiPage

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

Overrides:

getUnlimitedHeight in class StiPage

setUnlimitedHeight

public final void setUnlimitedHeight(boolean value)

Overrides:

setUnlimitedHeight in class StiPage

getUnlimitedWidth

public final boolean getUnlimitedWidth()

Description copied from class: StiPage

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

Overrides:

getUnlimitedWidth in class StiPage

setUnlimitedWidth

public final void setUnlimitedWidth(boolean value)

Overrides:

setUnlimitedWidth in class StiPage

getOrientation

public final StiPageOrientation getOrientation()

Description copied from class: StiPage

Gets or sets page orientation.

Overrides:

getOrientation in class StiPage

setOrientation

public final void setOrientation(StiPageOrientation value)

Overrides:

setOrientation in class StiPage

getPageWidth

public final double getPageWidth()

Description copied from class: StiPage

Gets or sets the total width of the page.

Overrides:

getPageWidth in class StiPage

setPageWidth

public final void setPageWidth(double value)

Overrides:

setPageWidth in class StiPage

getPageHeight

public final double getPageHeight()

Description copied from class: StiPage

Gets or sets the total height of the page.

Overrides:

getPageHeight in class StiPage

setPageHeight

public final void setPageHeight(double value)

Overrides:

setPageHeight in class StiPage

getSegmentPerWidth

public final int getSegmentPerWidth()

Description copied from class: StiPage

Gets or sets the number of segments per width.

Overrides:

getSegmentPerWidth in class StiPage

setSegmentPerWidth

public final void setSegmentPerWidth(int value)

Overrides:

setSegmentPerWidth in class StiPage

getSegmentPerHeight

public final int getSegmentPerHeight()

Description copied from class: StiPage

Gets or sets the number of segments per height.

Overrides:

getSegmentPerHeight in class StiPage

setSegmentPerHeight

public final void setSegmentPerHeight(int value)

Overrides:

setSegmentPerHeight in class StiPage

getColumnGaps

public final double getColumnGaps()

Description copied from class: StiPanel

Gets or sets distance between two columns.

Overrides:

getColumnGaps in class StiPanel

setColumnGaps

public final void setColumnGaps(double value)

Overrides:

setColumnGaps in class StiPanel

getColumnWidth

public final double getColumnWidth()

Description copied from class: StiPanel

Gets or sets width of column.

Overrides:

getColumnWidth in class StiPanel

setColumnWidth

public final void setColumnWidth(double value)

Overrides:

setColumnWidth in class StiPanel

getColumns

public final int getColumns()

Description copied from class: StiPanel

Gets or sets columns count.

Overrides:

getColumns in class StiPanel

setColumns

public final void setColumns(int value)

Overrides:

setColumns in class StiPanel

getCanShrink

public final boolean getCanShrink()

Description copied from class: StiComponent

gets or sets value which indicates that this object can shrink.

Specified by:

getCanShrink in interface IStiCanShrink

Overrides:

getCanShrink in class StiPage

setCanShrink

public final void setCanShrink(boolean value)

Specified by:

setCanShrink in interface IStiCanShrink

Overrides:

setCanShrink in class StiPage

getCanGrow

public final boolean getCanGrow()

Description copied from class: StiComponent

gets or sets a value which indicates that this object can grow.

Specified by:

getCanGrow in interface IStiCanGrow

Overrides:

getCanGrow in class StiPage

setCanGrow

public final void setCanGrow(boolean value)

Specified by:

setCanGrow in interface IStiCanGrow

Overrides:

setCanGrow in class StiPage

getPrintable

public final boolean getPrintable()

Description copied from class: StiComponent

gets or sets a value which indicates whether a component is printable or not.

Overrides:

getPrintable in class StiPage

setPrintable

public final void setPrintable(boolean value)

Overrides:

setPrintable in class StiPage

getBookmark

public final StiBookmarkExpression getBookmark()

Description copied from class: StiComponent

gets or sets the expression to fill a component bookmark.

Overrides:

getBookmark in class StiComponent

setBookmark

public final void setBookmark(StiBookmarkExpression value)

Overrides:

setBookmark in class StiComponent

getToolTip

public final StiToolTipExpression getToolTip()

Description copied from class: StiComponent

gets or sets the expression to fill a component tooltip.

Overrides:

getToolTip in class StiComponent

setToolTip

public final void setToolTip(StiToolTipExpression value)

Overrides:

setToolTip in class StiComponent

getHyperlink

public final StiHyperlinkExpression getHyperlink()

Description copied from class: StiComponent

gets or sets an expression to fill a component hyperlink.

Overrides:

getHyperlink in class StiComponent

setHyperlink

public final void setHyperlink(StiHyperlinkExpression value)

Overrides:

setHyperlink in class StiComponent

getEnabled

public final boolean getEnabled()

Description copied from class: StiComponent

gets or sets a value which indicates will this component be available or not.

Specified by:

getEnabled in interface IStiForm

Overrides:

getEnabled in class StiComponent

setEnabled

public final void setEnabled(boolean value)

Overrides:

setEnabled in class StiComponent

getBeginRenderEvent

public final StiBeginRenderEvent getBeginRenderEvent()

Description copied from class: StiPage

Occurs when when a page begins to render.

Overrides:

getBeginRenderEvent in class StiPage

setBeginRenderEvent

public final void setBeginRenderEvent(StiBeginRenderEvent value)

Overrides:

setBeginRenderEvent in class StiPage

getRenderingEvent

public final StiRenderingEvent getRenderingEvent()

Description copied from class: StiPage

Occurs when a page rendering.

Overrides:

getRenderingEvent in class StiPage

setRenderingEvent

public final void setRenderingEvent(StiRenderingEvent value)

Overrides:

setRenderingEvent in class StiPage

getEndRenderEvent

public final StiEndRenderEvent getEndRenderEvent()

Description copied from class: StiPage

Occurs when when a page ends to render.

Overrides:

getEndRenderEvent in class StiPage

setEndRenderEvent

public final void setEndRenderEvent(StiEndRenderEvent value)

Overrides:

setEndRenderEvent in class StiPage

getGetToolTipEvent

public final StiGetToolTipEvent getGetToolTipEvent()

Description copied from class: StiComponent

Occurs when getting the ToolTip for the component.

Overrides:

getGetToolTipEvent in class StiComponent

setGetToolTipEvent

public final void setGetToolTipEvent(StiGetToolTipEvent value)

Overrides:

setGetToolTipEvent in class StiComponent

getGetBookmarkEvent

public final StiGetBookmarkEvent getGetBookmarkEvent()

Description copied from class: StiComponent

Occurs when getting of the Bookmark for the component.

Overrides:

getGetBookmarkEvent in class StiComponent

setGetBookmarkEvent

public final void setGetBookmarkEvent(StiGetBookmarkEvent value)

Overrides:

setGetBookmarkEvent in class StiComponent

getGetHyperlinkEvent

public final StiGetHyperlinkEvent getGetHyperlinkEvent()

Description copied from class: StiComponent

Occurs when getting Hyperlink for the component.

Overrides:

getGetHyperlinkEvent in class StiComponent

setGetHyperlinkEvent

public final void setGetHyperlinkEvent(StiGetHyperlinkEvent value)

Overrides:

setGetHyperlinkEvent in class StiComponent

getBeforePrintEvent

public final StiBeforePrintEvent getBeforePrintEvent()

Description copied from class: StiComponent

Occurs before printing of the component.

Overrides:

getBeforePrintEvent in class StiComponent

setBeforePrintEvent

public final void setBeforePrintEvent(StiBeforePrintEvent value)

Overrides:

setBeforePrintEvent in class StiComponent

getAfterPrintEvent

public final StiAfterPrintEvent getAfterPrintEvent()

Description copied from class: StiComponent

Occurs after the component printing.

Overrides:

getAfterPrintEvent in class StiComponent

setAfterPrintEvent

public final void setAfterPrintEvent(StiAfterPrintEvent value)

Overrides:

setAfterPrintEvent in class StiComponent

getMouseEnterEvent

public final StiMouseEnterEvent getMouseEnterEvent()

Description copied from class: StiComponent

Occurs when user enters the mouse into the area of the component in the window of viewer.

Overrides:

getMouseEnterEvent in class StiComponent

setMouseEnterEvent

public final void setMouseEnterEvent(StiMouseEnterEvent value)

Overrides:

setMouseEnterEvent in class StiComponent

getMouseLeaveEvent

public final StiMouseLeaveEvent getMouseLeaveEvent()

Description copied from class: StiComponent

Occurs when user leaves the mouse out of the area of the component in the window of viewer.

Overrides:

getMouseLeaveEvent in class StiComponent

setMouseLeaveEvent

public final void setMouseLeaveEvent(StiMouseLeaveEvent value)

Overrides:

setMouseLeaveEvent in class StiComponent

getColumnBeginRenderEvent

public final StiColumnBeginRenderEvent getColumnBeginRenderEvent()

Description copied from class: StiPage

Occurs when start render column.

Overrides:

getColumnBeginRenderEvent in class StiPage

setColumnBeginRenderEvent

public final void setColumnBeginRenderEvent(StiColumnBeginRenderEvent value)

Overrides:

setColumnBeginRenderEvent in class StiPage

getColumnEndRenderEvent

public final StiColumnEndRenderEvent getColumnEndRenderEvent()

Description copied from class: StiPage

Occurs when end render column.

Overrides:

getColumnEndRenderEvent in class StiPage

setColumnEndRenderEvent

public final void setColumnEndRenderEvent(StiColumnEndRenderEvent value)

Overrides:

setColumnEndRenderEvent in class StiPage

getGetExcelSheetEvent

public final StiGetExcelSheetEvent getGetExcelSheetEvent()

Description copied from class: StiPage

Occurs when the ExcelSheet is calculated.

Overrides:

getGetExcelSheetEvent in class StiPage

setGetExcelSheetEvent

public final void setGetExcelSheetEvent(StiGetExcelSheetEvent value)

Overrides:

setGetExcelSheetEvent in class StiPage

getGetDrillDownReportEvent

public final StiGetDrillDownReportEvent getGetDrillDownReportEvent()

Description copied from class: StiComponent

Occurs when it is required to get a report for the Drill-Down operation.

Overrides:

getGetDrillDownReportEvent in class StiComponent

setGetDrillDownReportEvent

public final void setGetDrillDownReportEvent(StiGetDrillDownReportEvent value)

Overrides:

setGetDrillDownReportEvent in class StiComponent

getClickEvent

public StiClickEvent getClickEvent()

Gets or sets a script of the event Click.

Overrides:

getClickEvent in class StiComponent

setClickEvent

public void setClickEvent(StiClickEvent value)

Overrides:

setClickEvent in class StiComponent

getGetTagEvent

public StiGetTagEvent getGetTagEvent()

Description copied from class: StiComponent

Occurs when getting a Tag for a component.

Overrides:

getGetTagEvent in class StiComponent

setGetTagEvent

public void setGetTagEvent(StiGetTagEvent value)

Overrides:

setGetTagEvent in class StiComponent

getClosedFormEvent

public StiClosedFormEvent getClosedFormEvent()

Gets or sets a script of the event ClosedForm.

setClosedFormEvent

public void setClosedFormEvent(StiClosedFormEvent value)

getClosingFormEvent

public StiClosingFormEvent getClosingFormEvent()

Gets or sets a script of the event ClosingForm.

setClosingFormEvent

public void setClosingFormEvent(StiClosingFormEvent value)

getLoadFormEvent

public StiLoadFormEvent getLoadFormEvent()

Gets or sets a script of the event LoadForm.

setLoadFormEvent

public void setLoadFormEvent(StiLoadFormEvent value)

getControlWpf

public final Object getControlWpf()

Gets ot sets WPF control for this Report Control.

setControlWpf

public final void setControlWpf(Object value)

getWidth

public final double getWidth()

Description copied from class: StiPage

Gets or sets width.

Overrides:

getWidth in class StiPage

setWidth

public final void setWidth(int value)

getHeight

public final double getHeight()

Description copied from class: StiPage

Gets or sets height.

Overrides:

getHeight in class StiPage

setHeight

public final void setHeight(int value)

getLeft

public final double getLeft()

Description copied from class: StiPage

Gets or sets left margin.

Overrides:

getLeft in class StiPage

setLeft

public final void setLeft(int value)

getTop

public final double getTop()

Description copied from class: StiPage

Gets or sets top margin.

Overrides:

getTop in class StiPage

setTop

public final void setTop(int value)

getSize

public final StiSize getSize()

Gets or sets the size of the form.

Specified by:

getSize in interface IStiForm

setSize

public final void setSize(StiSize value)

Specified by:

setSize in interface IStiForm

getLocation

public final StiPoint getLocation()

Gets or sets the coordinates of the upper-left corner of the form.

setLocation

public final void setLocation(StiPoint value)

getDialogResult

public final int getDialogResult()

Gets or sets the dialog result for the form.

setDialogResult

public final void setDialogResult(int value)

getText

public String getText()

Gets or sets the text associated with this control.

Specified by:

getText in interface IStiForm

setText

public void setText(String value)

Specified by:

setText in interface IStiForm

getFont

public StiFont getFont()

Gets or sets font of control.

setFont

public void setFont(StiFont value)

getBackColor

public StiColor getBackColor()

Gets or sets the background color for the control.

setBackColor

public void setBackColor(StiColor value)

getTag

public StiTagExpression getTag()

Description copied from class: StiComponent

gets or sets the expression to fill a component tag.

Overrides:

getTag in class StiComponent

setTag

public void setTag(StiTagExpression value)

Overrides:

setTag in class StiComponent

getVisible

public boolean getVisible()

Gets or sets a value indicating whether the control is displayed.

Specified by:

getVisible in interface IStiForm

setVisible

public void setVisible(boolean value)

Specified by:

setVisible in interface IStiForm

updateReportControl

protected final void updateReportControl(String propertyName)

Use for update report control properties.

Parameters:

propertyName - A name of the property which will be updated.

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Overrides:

SaveToJsonObject in class StiPage

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Overrides:

LoadFromJsonObject in class StiPage

Throws:

JSONException