StiHeaderBand Class

Creates a new component of the type StiHeaderBand.

Creates a new component of the type StiHeaderBand with specified location.

Occurs after the component printing.

Gets or sets a text that will be shown instead of a component name. If the text is not indicated then the name is shown.

Gets a value which indicates whether deleting of the components is allowed.

Occurs before printing of the component.

Internal use only. Это свойство используется для блокирования измнения свойств бэнда, измнение которых во время построения бэнда может исказить результат.

Gets or sets the expression to fill a component bookmark.

Gets or sets the component bookmark.

Gets or sets frame of the component.

Gets bottom position of a component.

Gets or sets value which indicates how much free space is on a page (in per cent) should be reserved for formation of a new page or a new column. The value should be set in the range from 0 to 100. If the value is 100 then, in any case, a new page or a new column will be formed. This property is used together with NewPageBefore, NewPageAfter, NewColumnBefore, NewColumnAfter properties.

Gets or sets a brush to fill a component.

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

Gets or sets value indicates that this object can grow.

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

Occurs when user clicks on the component in the window of viewer.

Gets or sets the client area of a component.

Gets or sets collapsed value of the component.

Gets or sets a value which indicates placement of a simple component. Available values: "rt" - StiReportTitleBand "rs" - StiReportSummaryBand "ph" - StiPageHeaderBand "pf" - StiPageFooterBand "h" - StiHeaderBand "h.ap" - StiHeaderBand (OnAllPages) "f" - StiFooterBand "f.ap" - StiFooterBand (OnAllPages) "d" - StiDataBand "gh" - StiGroupHeaderBand "gf" - StiGroupFooterBand "e" - StiEmptyBand "p" - StiPage

Gets or sets a collection of components.

Gets or sets a style of a component.

Gets the type of processing when printing.

Gets or sets the collection of conditions.

Gets or sets current bookmark for this component.

Gets or sets the default client area of a component.

Gets or sets a value indicates that this component is used as the delimiter.

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

Gets or sets a value which indicates whether the component will be docked or not.

Gets or sets a type of the component docking.

Occurs when user double clicks on the component in the window of viewer.

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

Gets the footer height.

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.

Occurs when getting of the Bookmark for the component.

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

Occurs when getting Hyperlink for the component.

Occurs when getting a Tag for a component.

Occurs when getting the ToolTip for the component.

Gets or sets a guid of component.

Internal use only.

Gets header end color.

Gets the header height.

Gets header start color.

Gets or sets height of a component.

Gets or sets a state of highlight.

Gets or sets an expression to fill a component hyperlink.

Gets or sets hyperlink of a component.

Internal use only.

Gets interaction options of this component.

Gets a value which indicates whether invalidating of the component occurs when a mouse pointer is above the component.

Gets value indicates that this is an automatic docking.

Gets a value indicating that this is the Cross component.

Gets a value which indicates that the report in which a component is placed is being designed.

Gets a value which indicates that all events are empty.

Gets or sets value, which indicates that the report is exporting.

Gets a value which indicates that the component has already been printed.

Gets or sets a value which indicates whether the component is rendered or not.

Gets or sets value indicates is the component selected or not.

Gets or sets value indicates that header is printed with data together.

Gets or sets a value which indicates whether the object snap to the container is turned on.

Gets a localized name of the component category.

Gets a localized component name.

Gets or sets a value which indicates that moving is locked.

Gets or sets maximal height of band.

Gets or sets minimal height of band.

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

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

Gets or sets a name of a component.

If the value of this property is true, then, after output of a band, a new column will be generated.

If the value of this property is true, then, before output of a band, a new column will be generated. Output of a band will be continued on the next column.

If the value of this property is true, then, after output of a band, a new page will be generated.

If the value of this property is true, then, before output of a band, a new page will be generated. Output of a band will be continued on the next page.

Gets or sets the page on which an object is located.

Gets or sets the container in which an object is located.

Gets or sets parent bookmark for this component.

Gets or sets a value which indicates whether it is necessary to place component in toolbox or not.

Gets or sets value indicates that the footer is printed at bottom of page.

Gets or sets value indicates that the header if data not present.

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

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

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

Gets a component priority.

Gets or sets a value which indicates how many times the component is rendered.

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

Allows to reset page number on this band.

Gets or sets value which indicates the restrictions of a component.

Gets right position of a component.

Gets or sets a rectangle of the component selection.

Gets a category of services.

Gets a service name.

Gets a service type.

Gets or sets a value which indicates that this component can be shifted.

Gets or sets a value which indicates whether it is necessary to show quick buttons.

If the value of this property is true, then, a new page/column will be generated only starting from the second case.

Gets or sets value indicates that it is necessary to print every new string on a new page.

Gets or sets value which indicates how much free space on a page (in percentage terms) should be reserved for formation of a new page. The value should be set in the range from 0 to 100. If the value is 100 then, in any case, a new page will be formed. This property is used together with the StartNewPage property.

Gets the component states manager.

Gets or sets the expression to fill a component tag.

Gets or sets tag of a component.

Gets value to sort a position in the toolbox.

Gets or sets the expression to fill a component tooltip.

Gets or sets a component tips.

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

Increases the amount of pages on width and on height. Herewith on width or height of the page change all sizes a parent component.

Aligns, in the rectangle of selected objects, all selected objects.

Aligns to grid all selected components in the container.

Divides content of components in two parts. Returns result of dividing. If true, then component is successful divided.

Brings to front objects of the list in the container.

May this container be located in the specified component.

Changes the position of the selected component.

Clear all earlier saved object states.

Clears a text of all selected components.

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

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

Converts a value from the parent-container coordinates into coordinates of a page. The method calls the ContainerToPage method of the parent component.

Converts a point from the parent-container coordinates into coordinates of a page. The method calls the ContainerToPage method of the parent component.

Converts a rectangle from the parent-container coordinates into coordinates of a page. The method calls the ContainerToPage method of the parent component.

Converts a point of coordinates of the container into coodinates of a page.

Converts a rectangle from container coordinates into coordinates of a page.

Converts a component out of one unit into another.

Converts a component out of one unit into another.

Converts coordinates of all objects into coordinates of a page.

Converts objects from all coordinates into coordinates of a page without move them on a page.

Corrects in the container all objects which require motion between containers.

Corrects in container all objects which require moving.

Deserilizes object from XmlTextReader.

Invokes the GetBookmark event.

Docks the component and all of its subordinate components.

Docks a rectangle, relatively to the component, into the rectangle.

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Returns a frame of the object of the type IStiBorder being met first. Scans all selected objects in the container.

Returns a brush of an object of the type StiBrush being met first. Scans all selected objects in the container.

Returns an object in which zone of controlling coordinates are got.

Returns an object in which zone of controlling coordinates are got.

Returns an object in which zone of controlling coordinates are got.

Returns an object in which zone of controlling coordinates are got.

Returns the list of all components which are located in the container.

Returns the list of all components which are located in the container.

Returns the list of all components which are located in the container.

Returns conditions of an object of the type. Scans all selected objects in the container.

Returns the topmost Container(StiPanel or StiPage) in which the component is located. Returns null, if nothing is located.

Returns an container in which client zone coordinates are got.

Returns the DataBand in which the component is located. Returns null, if nothing is located.

Returns a rectangle of the component showing.

Returns the first docked and selected component.

Retuns an empty rectangle to which docking is possible.

Retuns an empty rectangle to which docking is possible.

Returns the style of docking of the component being met first. Scans all selected objects in the container.

Returns events collection of this component.

Returns the first selected component.

Returns a font of an object of the type IStiFont being met first. Scans all selected objects in the container.

Returns the GroupHeaderBand in which the component is located. Returns null, if nothing is located.

Serves as the default hash function.

Returns the band header text.

Returns a horizontal alignment of the object of the type IStiHorAlignment being met first. Scans all selected objects in the container.

Returns the list of all objects which require motion between containers.

Returns the list of all objects which require motion between containers.

Returns the level of the object nesting. Level 1 - page, 2 - page and etc.

Returns linked of the object being met first. Scans all selected objects in the container.

Returns lock of the object being met first. Scans all selected objects in the container.

Returns maximum sizes among selected objects.

Makes all necessary coversions for showing an object and returns its coordinates.

Makes all necessary conversions for the object output and returns its coordinates.

Makes all necessary conversions for the object output and returns its coordinates.

The rectangle includes all selected objects in the container. The rectangle is represented in page coordinates.

Returns the array of the selected components.

Returns the array of the selected components.

Returns the array of the selected objects including child of the selected objects.

Returns the rectangle that includes all selected objects in the container. The rectangle is represented in page coordinates.

The rectangle includes all selected objects in the container and children containers which are located in the selected containers. The rectangle is represented in page coordinates.

Returns a brush of an object of the type IStiTextBrush being met first. Scans all selected objects in the container.

Returns a format of an object of the type IStiText being met first. Scans all selected objects in the container.

Returns a horizontal alignment of an object of the type IStiTextHorAlignment being met first. Scans all selected objects in the container.

Gets a thumbnail image of the component.

Gets a thumbnail image of the component.

Gets a thumbnail image of the component.

Gets a thumbnail image in the byte aray of the component.

Gets the Type of the current instance.

Returns a vertical alignment of the object of the type IStiVertAlignment being met first. Scans all selected objects in the container.

Renders a component in the specified container without generation of the 'BeforePrintEvent' event and the 'AfterPrintEvent' event and without checking Conditions. The rendered component will return in 'renderedComponent' argument.

Invert selection of component.

Raises the AfterPrint event.

Raises the BeforePrint event.

Raises the Click event for this report.

Raises the DoubleClick event for this report.

Invokes all events for this components.

Raises the GetBookmark event.

Raises the GetDrillDownReport event for this report.

Raises the GetHyperlink event.

Raises the GetTag event.

Raises the GetToolTip event.

Raises the MouseEnter event for this report.

Raises the MouseLeave event for this report.

Raises the Painted event for this component.

Raises the Painting event for this component.

Puts components which are equivalent to their width.

Sets the height to all selected objects.

Sets the size to all selected objects.

Sets the width to all selected objects.

Puts components which are equal in their height.

Creates a shallow copy of the current Object.

Moves backward objects of the list in the container.

Converts coordinates of all objects into coordinates of a page and moves objects on the page.

Moves forward objects of the list in the container.

Normalizes all selected objects in the container.

Raises the AfterPrint event.

Raises the BeforePrint event.

Raises the Click event for this report.

Raises the DoubleClick event for this report.

Raises the GetBookmark event.

Raises the GetDrillDownReport event for this report.

Raises the GetHyperlink event.

Raises the GetTag event.

Raises the GetToolTip event.

Raises the MouseEnter event for this report.

Raises the MouseLeave event for this report.

Raises the Painted event for this component.

Raises the Painting event for this component.

Packs a service.

Converts a point from coordinates of a page into the parent-container coordinates. The method calls the PageToContainer method of the parent component.

Converts a rectangle from coordinates of a page into the parent-container coordinates. The method calls the PageToContainer method of the parent component.

Converts a point of coordinates of a page into coodinates of a container.

Converts a rectangle from coordinates of a page into container coordinates.

Paints a component.

Paints events of a component.

Paints the highlight of the component.

Paints a markers specified by a Rectangle structure. This method can be used only in win version.

Paints the selection of the component.

Specifies whether it is possible to place the component on the ColumnBand.

Prepare content for rendering.

Removes all selected object from the container.

Removes all selected object from the container.

Renders a component in the specified container with events generation.

Renders a component in the specified container with events generation. The rendered component will return in 'renderedComponent' argument.

Renders a component in the specified container without generation of the 'BeforePrintEvent' event and the 'AfterPrintEvent' event and without checking Conditions. The rendered component will return in 'renderedComponent' argument. This is backward compatibility method. Please use InternalRender method for new developed components.

Rendering a container without invokes events.

Reset selection of component.

Resets selection from all selected objects in the container.

Restores the earlier saved object state.

Saves the current state of an object.

Select component.

Select all components in container.

Selects the specified component in the container.

Selects all objects in the container which intersect with the specified rectangle.

Sends to back objects of the list in the container.

Serializes object into XmlTextWriter.

Sets StiBorder from all selected objects in the container. Sets Side, DropShadow, Color, Style. All other elements are ignored.

Sets IStiBrush from all selected objects in the container.

Centers horizontally all selected objects.

Centers vertically all selected objects.

Sets conditions to all selected objects in the container.

Sets Dock from all selected objects in the container.

Sets IStiFont from all selected objects in the container.

Sets StiHorAlignment from all selected objects in the container.

Sets Link from all selected objects in the container.

Sets Lock from all selected objects in the container.

Internal use only.

Sets IStiTextBrush from all selected objects in the container.

Sets StiFormatService from all selected objects in the container.

Sets StiTextHorAlignment from all selected objects in the container.

Sets StiVertAlignment from all selected objects in the container.

Returns an Name of the component and/or the Alias of the component.

Clear component afrer render.

Occurs after the component printing.

Occurs before printing of the component.

Occurs when user clicks on the component in the window of viewer.

Occurs when user double clicks on the component in the window of viewer.

Occurs when getting of the Bookmark for the component.

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

Occurs when getting Hyperlink for the component.

Occurs when getting a Tag for a component.

Occurs when getting the ToolTip for the component.

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

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

Occurs after the component was painted.

Occurs before the component painting.