Packagestimulsoft.report.dialogs
Classpublic class StiForm
InheritanceStiForm Inheritance StiPage Inheritance StiPanel Inheritance StiContainer Inheritance StiComponent Inheritance StiBase Inheritance StiService Inheritance StiObject Inheritance Object
Implements IStiForm



Public Properties
 PropertyDefined By
 InheritedafterPrintEvent : StiAfterPrintEvent
Occurs after the component printing.
StiComponent
 Inheritedalias : String
Gets or sets a text that will be shown instead of a component name.
StiComponent
 InheritedallowDelete : Boolean
[read-only] Gets a value which indicates whether deleting of the components is allowed.
StiComponent
 InheritedbeforePrintEvent : StiBeforePrintEvent
Occurs before printing of the component.
StiComponent
 InheritedbeginRenderEvent : StiBeginRenderEvent
Occurs when when a page begins to render.
StiPage
 Inheritedblocked : Boolean
Internal use only.
StiContainer
 Inheritedbookmark : StiBookmarkExpression
Gets or sets the expression to fill a component bookmark.
StiComponent
 InheritedbookmarkValue : String
Gets or sets the component bookmark.
StiComponent
 Inheritedborder : StiBorder
Gets or sets frame of the component.
StiContainer
 Inheritedbottom : Number
[override] [read-only] Gets bottom margin.
StiPage
 Inheritedbrush : StiBrush
Gets or sets a brush to fill a component.
StiContainer
 InheritedcanBreak : Boolean
[override]
StiPage
 InheritedcanGrow : Boolean
[override]
StiPage
 InheritedcanShrink : Boolean
[override]
StiPage
 InheritedclickEvent : StiClickEvent
Occurs when user clicks on the component in the window of viewer.
StiComponent
 InheritedclientRectangle : StiRectangle
[override] Gets or sets the client area of a component.
StiPage
 InheritedcollapsedValue : Object
Gets or sets collapsed value of the component.
StiContainer
 InheritedcollapsingIndex : int
StiContainer
 InheritedcolumnBeginRenderEvent : StiColumnBeginRenderEvent
Occurs when start render column.
StiPage
 InheritedcolumnEndRenderEvent : StiColumnEndRenderEvent
Occurs when end render column.
StiPage
 InheritedcolumnGaps : Number
Gets or sets distance between two columns.
StiPanel
 Inheritedcolumns : int
Gets or sets columns count.
StiPanel
 InheritedcolumnWidth : Number
Gets or sets width of column.
StiPanel
 InheritedcomponentPlacement : String
StiComponent
 Inheritedcomponents : StiComponentsCollection
Gets or sets a collection of components.
StiContainer
 InheritedcomponentStyle : String
Gets or sets a style of a component.
StiComponent
 InheritedcomponentType : int
[override] [read-only] Gets the type of processing when printing.
StiContainer
 Inheritedconditions : StiConditionsCollection
Gets or sets the collection of conditions.
StiComponent
 InheritedcontainerInfoV2 : StiContainerInfoV2
[read-only]
StiContainer
 InheritedcurrentBookmark : StiBookmark
Gets or sets current bookmark for this component.
StiComponent
 InheritedcurrentHeightSegment : int
Gets or sets the current height of a page segment.
StiPage
 InheritedcurrentWidthSegment : int
Gets or sets the current width of a page segment.
StiPage
 InheriteddefaultClientRectangle : StiRectangle
[override] [read-only] Gets or sets the default client area of a component.
StiContainer
 InheriteddelimiterComponent : Boolean
Gets or sets a value indicates that this component is used as the delimiter.
StiComponent
 InheriteddenyDrawSegmentMode : Boolean
Internal use only.
StiPage
 InheriteddisplayRectangle : StiRectangle
[override] Gets or sets a rectangle of the component which it fills.
StiPage
 Inheriteddockable : Boolean
Gets or sets a value which indicates whether the component will be docked or not.
StiComponent
 InheriteddockStyle : int
[override] Gets or sets a type of the component docking.
StiPage
 InheriteddoubleClickEvent : StiDoubleClickEvent
Occurs when user double clicks on the component in the window of viewer.
StiComponent
 InheriteddrillDownActivated : Boolean
StiPage
 InheriteddrillDownParameters : StiDictionaryCollection
StiComponent
 Inheritedenabled : Boolean
Gets or sets a value which indicates will this component be available or not.
StiComponent
 InheritedendRenderEvent : StiEndRenderEvent
Occurs when when a page ends to render.
StiPage
 InheritedexcelSheet : StiExcelSheetExpression
Gets or sets an expression used for generation name of excel sheet.
StiPage
 InheritedexcelSheetValue : String
Gets or sets name of excel sheet.
StiPage
 InheritedforceRedrawAll : 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
  form : XMLNode
Сохранённые свойства и компоненты формы.
StiForm
 InheritedgetBookmarkEvent : StiGetBookmarkEvent
Occurs when getting a Bookmark for the component.
StiComponent
 InheritedgetDrillDownReportEvent : StiGetDrillDownReportEvent
Occurs when it is required to get a report for the Drill-Down operation.
StiComponent
 InheritedgetExcelSheetEvent : StiGetExcelSheetEvent
Occurs when the ExcelSheet is calculated.
StiPage
 InheritedgetHyperlinkEvent : StiGetHyperlinkEvent
Occurs when getting a Hyperlink for the component.
StiComponent
 InheritedgetTagEvent : StiGetTagEvent
Occurs when getting a Tag for the component.
StiComponent
 InheritedgetToolTipEvent : StiGetToolTipEvent
Occurs when getting a ToolTip for the component.
StiComponent
 InheritedgridSize : Number
[read-only] Gets grid size in the unit.
StiPage
 InheritedgrowToHeight : Boolean
[override]
StiPage
 Inheritedguid : String
StiComponent
 InheritedhasSelected : Boolean
[read-only] Internal use only.
StiContainer
 Inheritedheight : Number
[override] Gets or sets height.
StiPage
 InheritedhighlightState : int
Gets or sets a state of highlight.
StiComponent
 Inheritedhyperlink : StiHyperlinkExpression
Gets or sets an expression to fill a component hyperlink.
StiComponent
 InheritedhyperlinkValue : String
Gets or sets hyperlink of a component.
StiComponent
 InheritedignoreNamingRule : Boolean
Internal use only.
StiComponent
 Inheritedinherited : Boolean
StiComponent
 Inheritedinteraction : StiInteraction
Gets interaction options of this component.
StiComponent
 InheritedisAllowUseInTableMode : Boolean
[read-only] Возможно ли добавиль компонент в групповое выделение
StiComponent
 InheritedisAutomaticDock : Boolean
[override] [read-only] Gets value indicates that this is an automatic docking.
StiPage
 InheritedisCross : Boolean
[read-only]
StiComponent
 InheritedisDesigning : Boolean
[read-only] Gets a value which indicates that the report in which a component is placed is being designed.
StiComponent
 InheritedisEnabled : Boolean
[read-only]
StiComponent
 InheritedisExporting : Boolean
[read-only] Gets or sets value, which indicates that the report is exporting.
StiComponent
 InheritedisPrinted : Boolean
StiPage
 InheritedisPrinting : Boolean
[read-only] Gets a value which indicates that the component has already been printed.
StiComponent
 InheritedisRendered : Boolean
Gets or sets a value which indicates whether a component is rendered or not.
StiComponent
 InheritedisSelected : Boolean
Gets or sets value indicates is the component selected or not.
StiComponent
 InheritedisThumbnails : Boolean
[read-only]
StiComponent
 InheritedlargeHeight : Boolean
Gets or sets value indicates that this page has in designer large height.
StiPage
 InheritedlargeHeightFactor : int
Gets or sets large height factor for LargeHeight property of this page.
StiPage
 Inheritedleft : Number
[override] Gets or sets left margin.
StiPage
 Inheritedlinked : Boolean
[override]
StiPage
 InheritedlocalizedCategory : String
[read-only] Gets a localized name of the component category.
StiBase
 InheritedlocalizedName : String
[override] [read-only] Gets a localized component name.
StiPage
 Inheritedlocked : Boolean
[override]
StiPage
 InheritedlockHighlight : Boolean
StiPage
 Inheritedmargins : StiMargins
Gets or sets page margins.
StiPage
 InheritedmaxSize : StiSize
[override]
StiPage
 InheritedminSize : StiSize
[override]
StiPage
 InheritedmouseEnterEvent : StiMouseEnterEvent
Occurs when user enters the mouse into the area of the component in the window of viewer.
StiComponent
 InheritedmouseLeaveEvent : StiMouseLeaveEvent
Occurs when user leaves the mouse into the area of the component in the window of viewer.
StiComponent
 Inheritedname : String
[override] Gets or sets a name of a component.
StiComponent
 InheritednumberOfCopies : int
Gets or sets a value of number of copies of the current page.
StiPage
 InheritedoffsetRectangle : StiRectangle
Gets or sets offset of the selected components on the page.
StiPage
 Inheritedorientation : int
Gets or sets page orientation.
StiPage
 Inheritedpage : StiPage
[override]
StiPage
 InheritedpageHeight : Number
Gets or sets the total height of the page.
StiPage
 InheritedpageInfoV2 : StiPageInfoV2
[read-only]
StiPage
 InheritedpageWidth : Number
Gets or sets the total width of the page.
StiPage
 InheritedpaperSize : int
Gets or sets the page size.
StiPage
 InheritedpaperSourceFirstPage : int
Gets or sets the paper source for first page.
StiPage
 InheritedpaperSourceOfFirstPage : String
Gets or sets the paper source for first page.
StiPage
 InheritedpaperSourceOfOtherPages : String
Gets or sets the paper source for other pages.
StiPage
 InheritedpaperSourceOtherPages : int
Gets or sets the paper source for other pages.
StiPage
 Inheritedparent : StiContainer
[override]
StiPage
 InheritedparentBookmark : StiBookmark
Gets or sets parent bookmark for this component.
StiComponent
 InheritedparentComponentIsBand : Boolean = false
Если true, то Parent компонент этого контейнера является Band.
StiContainer
 Inheritedprintable : Boolean
[override]
StiPage
 InheritedprintHeadersFootersFromPreviousPage : Boolean
Gets or sets value which indicates that, on this page, it is necessary to print headers and footers of the previous page.
StiPage
 InheritedprintOn : int
[override]
StiPage
 InheritedprintOnPreviousPage : Boolean
Gets or sets value that indicates that the page will start to be rendered on the free space of the previous page.
StiPage
 Inheritedpriority : int
[override] [read-only] Gets a component priority.
StiPanel
 Inheritedproperties : StiRepositoryItems
StiService
 Inheritedref : int
StiBase
 InheritedrenderedCount : int
Gets or sets a value which indicates how many times a component is rendered.
StiComponent
 InheritedrenderingEvent : StiRenderingEvent
Occurs when a page rendering.
StiPage
 Inheritedreport : StiReport
[override] Gets or sets the report in which the page is located.
StiPage
 InheritedreportUnit : StiUnit
Used for save/load page.
StiPage
 InheritedresetPageNumber : Boolean
Allows to reset page number on this page.
StiPage
 Inheritedrestrictions : int
[override]
StiPage
 Inheritedright : Number
[override] [read-only] Gets right margin.
StiPage
 InheritedrightToLeft : Boolean
Gets or sets horizontal column direction.
StiPanel
 InheritedsegmentPerHeight : int
Gets or sets the number of segments per height.
StiPage
 InheritedsegmentPerWidth : int
Gets or sets the number of segments per width.
StiPage
 InheritedselectedComponents : StiArrayList
[read-only]
StiPage
 InheritedselectedRectangle : StiRectangle
Internal use only.
StiPage
 InheritedselectionTick : int
StiComponent
 InheritedselectRectangle : StiRectangle
Gets or sets a rectangle of a component selection.
StiComponent
 InheritedserviceCategory : String
[read-only] Gets a service category.
StiService
 InheritedserviceInfo : String
[read-only] Gets a service description.
StiService
 InheritedserviceName : String
[override] [read-only] Gets a service name.
StiBase
 InheritedserviceType : Class
[read-only] Gets a service type.
StiService
 Inheritedshift : Boolean
Gets or sets a value which indicates that this component can be shifted.
StiComponent
 InheritedshiftMode : int
[override]
StiPage
 InheritedshowQuickButtons : Boolean
Gets or sets a value which indicates whether it is necessary to show quick buttons.
StiComponent
 Inheritedskip : Boolean
Gets or sets value, indicates that, when rendering of the report, this page of the report is to be skipped.
StiPage
 Inheritedstates : StiStatesManager
[read-only] Gets the component states manager.
StiComponent
 InheritedstopBeforePrint : int
Gets or sets the page number.
StiPage
 InheritedstretchToPrintArea : Boolean
Gets or sets value, indicates that, when printing, a page stretches into print area.
StiPage
 Inheritedtag : StiTagExpression
Gets or sets the expression to fill a component tag.
StiComponent
 InheritedtagValue : String
Gets or sets tag of a component.
StiComponent
 InheritedtitleBeforeHeader : Boolean
Gets or sets value, indicates that it is necessary to put the report title before the page header.
StiPage
 InheritedtoolTip : StiToolTipExpression
Gets or sets the expression to fill a component tooltip.
StiComponent
 InheritedtoolTipValue : String
Gets or sets a component tips.
StiComponent
 Inheritedtop : Number
[override] Gets or sets top margin.
StiPage
 Inheritedunit : StiUnit
[read-only]
StiPage
 InheritedunlimitedBreakable : Boolean
Gets or sets value indicates that when printing of multiple-sheet cross-reports, columns and strings are to be broken.
StiPage
 InheritedunlimitedHeight : Boolean
Gets or sets value, indicates that the page has an unlimited height.
StiPage
 InheritedunlimitedWidth : Boolean
Gets or sets value, indicates that the page has an unlimited width.
StiPage
 InheriteduseParentStyles : Boolean
[override]
StiPage
 Inheritedwatermark : StiWatermark
Gets or sets watermark of the page.
StiPage
 Inheritedwidth : Number
[override] Gets or sets width.
StiPage
 Inheritedzoom : Number
[read-only] Gets zoom of a report.
StiPage
Public Methods
 MethodDefined By
  
StiForm(report:StiReport = null)
StiForm
 Inherited
alignTo(aligning:String):void
Aligns, in the rectangle of selected objects, all selected objects.
StiContainer
 Inherited
alignToGrid(comp:StiComponent = null):void
Aligns to grid all selected components in the container.
StiContainer
 Inherited
applyConditions(sender:Object, conditions:StiArrayList):void
StiComponent
 Inherited
breakk(dividedComponent:StiComponent, devideFactor:Number):Boolean
Divides content of components in two parts.
StiContainer
 Inherited
Brings to front objects of the list in the container.
StiContainer
 Inherited
canContainIn(component:StiComponent):Boolean
Specifies that this component may be located in the specified component.
StiComponent
 Inherited
Changes the position of the selected component.
StiContainer
 Inherited
StiComponent
 Inherited
[override] Clear all earlier saved object states.
StiContainer
 Inherited
clearPage():void
StiPage
 Inherited
clone(... args):Object
[override]
StiPage
 Inherited
componentToPage(value:Number):Number
Converts a rectangle from the parent-container coordinates into coordinates of a page.
StiComponent
 Inherited
Converts a rectangle from the parent-container coordinates into coordinates of a page.
StiComponent
 Inherited
Converts a rectangle from the parent-container coordinates into coordinates of a page.
StiComponent
 Inherited
Converts a rectangle from container coordinates into coordinates of a page.
StiContainer
 Inherited
Converts a point of coordinates of the container into coodinates of a page.
StiContainer
 Inherited
convert(oldUnit:StiUnit, newUnit:StiUnit, convertComponents:Boolean = true):void
[override] Converts a component out of one unit into another.
StiPage
 Inherited
convertFromHInches(unit:StiUnit, value:Number):Number
StiPage
 Inherited
convertToHInches(unit:StiUnit, value:Number):Number
StiPage
 Inherited
correct(onlySelect:Boolean = false):void
Corrects in the container all objects which require motion between containers.
StiContainer
 Inherited
deserializeDocument(value:XMLNode):void
StiContainer
 Inherited
doBookmark():void
Invokes the GetBookmark event.
StiComponent
 Inherited
Docks the component and all of its subordinate components.
StiComponent
 Inherited
StiComponent
 Inherited
Raises the GetBookmark event.
StiComponent
 Inherited
[static]
StiComponent
 Inherited
equals(object:Object):Boolean
[override]
StiPage
 Inherited
[override]
StiContainer
 Inherited
getBorder():Object
Returns a frame of the object of the type IStiBorder being met first.
StiContainer
 Inherited
StiPanel
 Inherited
getComponentInControl(x:Number, y:Number, usePage:Boolean):StiComponent
Returns an object in which zone of controlling coordinates are got.
StiContainer
 Inherited
getComponentInPoint(x:Number, y:Number):StiComponent
Returns an object in which zone of controlling coordinates are got.
StiContainer
 Inherited
Returns the list of all components which are located in the container.
StiContainer
 Inherited
getComponentsCount(container:StiContainer = null):int
StiPage
 Inherited
Returns an container in which client zone coordinates are got.
StiContainer
 Inherited
Returns the DataBand in which the component is located.
StiComponent
 Inherited
Returns a rectangle of the component showing.
StiComponent
 Inherited
Returns the first docked and selected component.
StiContainer
 Inherited
getDockRegion(parent:StiComponent, useColumns:Boolean = true):StiRectangle
Retuns an empty rectangle to which docking is possible.
StiComponent
 Inherited
Returns the first selected component.
StiContainer
 Inherited
Returns the GroupHeaderBand in which the component is located.
StiComponent
 Inherited
getIncorrect(onlySelect:Boolean = false):StiComponentsCollection
Returns the list of all objects which require motion between containers.
StiContainer
 Inherited
getLink():Object
Returns linked of the object being met first.
StiContainer
 Inherited
getLock():Object
Returns lock of the object being met first.
StiContainer
 Inherited
getPaintRectangle(convertToHInches:Boolean = true, convertZoom:Boolean = true, docking:Boolean = true):StiRectangle
Makes all necessary coversions for showing an object and returns its coordinates.
StiComponent
 Inherited
getQuickInfo():String
StiComponent
 Inherited
getReport():Object
StiComponent
 Inherited
Returns the array of the selected components.
StiContainer
 Inherited
Returns the array of the selected objects including child of the selected objects.
StiContainer
 Inherited
Returns the rectangle that includes all selected objects in the container.
StiContainer
 Inherited
Get a short object type name (without library path).
StiObject
 Inherited
getType():Class
StiObject
 Inherited
getTypeName():String
StiObject
 Inherited
StiComponent
 Inherited
invert():void
Invert selection of component.
StiComponent
 Inherited
invokeAfterPrint(sender:Object):void
Raises the AfterPrint event.
StiComponent
 Inherited
invokeBeforePrint(sender:Object):void
Raises the BeforePrint event.
StiComponent
 Inherited
[override]
StiPage
 Inherited
isExportAsImage(format:int):Boolean
StiComponent
 Inherited
isParentSelect(component:StiComponent):Boolean
[static] Retuns true if one of the parent component is selected.
StiComponent
 Inherited
isSimple(object:*):Boolean
[static]
StiObject
 Inherited
Puts components which are equivalent to their width.
StiContainer
 Inherited
makeSameHeight(height:Number):void
Sets the height to all selected objects.
StiContainer
 Inherited
Sets the size to all selected objects.
StiContainer
 Inherited
makeSameWidth(width:Number):void
Sets the width to all selected objects.
StiContainer
 Inherited
Puts components which are equal in their height.
StiContainer
  
[override]
StiForm
 Inherited
Moves backward objects of the list in the container.
StiContainer
 Inherited
Converts coordinates of all objects into coordinates of a page and moves objects on the page.
StiContainer
 Inherited
Moves forward objects of the list in the container.
StiContainer
 Inherited
newGuid():void
StiComponent
 Inherited
normalize():void
Normalizes all selected objects in the container.
StiContainer
 Inherited
offsetLocation(offsetX:Number, offsetY:Number):void
StiContainer
 Inherited
[override] Packs a service.
StiComponent
 Inherited
Converts a rectangle from coordinates of a page into the parent-container coordinates.
StiComponent
 Inherited
Converts a rectangle from coordinates of a page into the parent-container coordinates.
StiComponent
 Inherited
Converts a rectangle from coordinates of a page into container coordinates.
StiContainer
 Inherited
Converts a point from coordinates of a page into container coordinates.
StiContainer
 Inherited
paint(args:StiPaintArgs):void
StiComponent
 Inherited
StiComponent
 Inherited
prepare():void
Подготавливает компонент для рендеринга.
StiComponent
 Inherited
StiComponent
 Inherited
StiComponent
 Inherited
reset():void
Reset selection of component.
StiComponent
 Inherited
Resets selection from all selected objects in the container.
StiContainer
 Inherited
restoreState(stateName:String):void
[override] Restores the earlier saved object state.
StiContainer
 Inherited
saveState(stateName:String):void
[override] Saves the current state of an object.
StiContainer
 Inherited
select():void
Select component.
StiComponent
 Inherited
selectAll():void
Select all components in container.
StiContainer
 Inherited
Selects the specified component in the container.
StiContainer
 Inherited
Selects all objects in the container which intersect with the specified rectangle.
StiContainer
 Inherited
StiContainer
 Inherited
sendToBack():void
Sends to back objects of the list in the container.
StiContainer
 Inherited
StiContainer
 Inherited
setBorder(border:StiBorder):void
Sets StiBorder from all selected objects in the container.
StiContainer
 Inherited
Centers horizontally all selected objects.
StiContainer
 Inherited
Centers vertically all selected objects.
StiContainer
 Inherited
setLink(linked:Boolean):void
Sets Link from all selected objects in the container.
StiContainer
 Inherited
setLock(locked:Boolean):void
Sets Lock from all selected objects in the container.
StiContainer
 Inherited
Internal use only.
StiComponent
 Inherited
StiContainer
 Inherited
StiComponent
 Inherited
StiContainer
 Inherited
toString():String
Returns an Alias of the report or the Name of the report.
StiComponent
 Inherited
unPrepare():void
Очищает компонент после рендеринга.
StiComponent
Protected Methods
 MethodDefined By
 Inherited
allowPrintOn():Boolean
StiComponent
 Inherited
checkBlockedException(propertyName:String):void
StiContainer
 Inherited
StiComponent
Protected Constants
 ConstantDefined By
 InheritedPropertyBlocked : Object
[static]
StiContainer
 InheritedPropertyComponentStyle : Object
[static]
StiComponent
 InheritedPropertyDelimiterComponent : Object
[static]
StiComponent
 InheritedPropertyDockable : Object
[static]
StiComponent
 InheritedPropertyInherited : Object
[static]
StiComponent
 InheritedPropertyLinked : Object
[static]
StiComponent
 InheritedPropertyLocked : Object
[static]
StiComponent
 InheritedPropertyRenderedCount : Object
[static]
StiComponent
 InheritedPropertyRestrictions : Object
[static]
StiComponent
 InheritedPropertySelectionTick : Object
[static]
StiComponent
 InheritedPropertyShowQuickButtons : Object
[static]
StiComponent
 InheritedPropertyUseParentStyles : Object
[static]
StiComponent
Property Detail
formproperty
form:XMLNode

Сохранённые свойства и компоненты формы.


Implementation
    public function get form():XMLNode
    public function set form(value:XMLNode):void
Constructor Detail
StiForm()Constructor
public function StiForm(report:StiReport = null)



Parameters
report:StiReport (default = null)
Method Detail
memberwiseClone()method
override public function memberwiseClone():Object

Returns
Object