StiEngine Members

The following tables list the members exposed by StiEngine.

	Name	Description
	AddContainerToDestination	Adds a specified container into the container for output.
	AddFooterMarker	Adds a FooterMarker (special container) into the current container of output. A container-marker is used for the engine to know on what place in a container of output FooterBands for PrintOnAllPages should be replaced after their rendering is complete.
	AddKeepLevelAtLatestDataBand	Adds a container-marker of the beginning of grouping before the last rendered DataBand.
	AddLevel	Adds a container-marker of the beginning of grouping into the current position of output in the stream.
	AddPageToRenderedPages	Adds a specified page into the collection of rendered pages.
	CheckForDuplicate	This is CheckForDuplicate, a member of class StiEngine.
	ClearPageBreakSkipFirst	Clears a collection of bands which once passed the generation of a new page or column.
	FinalClear	A method is called to finalize operations over the output stream.
	FinishColumns	Находит все контейнеры - колонки и завершает их. Процедура завершения включает в себя вызов метода FinishColumns. Этот метод располагает контейнеры в колонки.
	FinishContainer	Find all containers and zero the ParentBand property.
	FinishResetPageNumberContainer	Метод проверяет свойство ResetPageNumber и если необходимо сбрасывает номер страницы.
	GetComponentByNameFromRenderedPage	This is GetComponentByNameFromRenderedPage, a member of class StiEngine.
	GetSumTagsOnPage	This is GetSumTagsOnPage, a member of class StiEngine.
	NewColumn	This is the overview for the NewColumn method overload.
	NewDestination	This is the overview for the NewDestination method overload.
	NewList	This is the overview for the NewList method overload.
	NewPage	This is the overview for the NewPage method overload.
	RemoveBandFromPageBreakSkipList	This is RemoveBandFromPageBreakSkipList, a member of class StiEngine.
	RemoveLevel	Adds a container-marker of the end of grouping into the current position of output in the stream.
	RenderBand	This is the overview for the RenderBand method overload.
	ResetProcessingDuplicates	This is the overview for the ResetProcessingDuplicates method overload.
	StiEngine	This is StiEngine, a member of class StiEngine.

Internal Methods

	Name	Description
	CanGenerateNewContainer	Returns true if the specified container can generate a new page or a column in this time. If the SkipFirst property is false then, in any case true is returned. If true, то на первый раз метод запрещает генерировать новую колонку или новую страницу и заносит бэнд в коллекцию.
	InvokePageAfterPrint	This is InvokePageAfterPrint, a member of class StiEngine.
	ProcessLastPageAfterRendering	This is ProcessLastPageAfterRendering, a member of class StiEngine.
	ProcessPageAfterRendering	This is ProcessPageAfterRendering, a member of class StiEngine.
	RenderContainer	Renders a specified container in the current container for output.
	RenderEmptyBands	Render selected EmptyBand in the specified container.
	RenderFootersOnAllPages	Производит поиск и вывод внизу страницы, всех Footers из указанного контейнера вывода. Выводятся только те элементы, которые будут найдены до контейнера - маркера. Остальные элементы будут перенесены позднее на следующию страницу. Все выводимые элементы должны быть найдены в составленном ранее списке выводимых на всех страницах Footers. При обработке, контейнерам устанавливается новая позиция по вертикали внизу страницы.
	RenderPrintAtBottom	Производит поиск и вывод на новой странице, всех элементов из указанного контейнера вывода. Выводятся только те элементы, которые будут найдены до контейнера - маркера. Остальные элементы будут перенесены позднее на следующию страницу. Все выводимые элементы должны быть найдены в составленном ранее списке выводимых внизу страницы бэндов. При обработке, контейнерам устанавливается новая позиция по вертикали внизу страницы.
	SetNewPageParameters	Sets parameters to output a new page.

Public Fields

	Name	Description
	SpecialContainerHeight	This is SpecialContainerHeight, a member of class StiEngine.
	SpecialContainerHeight2	This is SpecialContainerHeight2, a member of class StiEngine.

Public Properties

	Name	Description
	ContainerForRender	Gets or sets a container in what rendering of bands is done.
	CrossFreeSpace	Contains a freespace in a container in what the printing is done. Used to output Cross bands only.
	FreeSpace	Contains a freespace in a container in what the printing is done.
	IgnoreUnlimitedHeightForNewPage	If true then UnlimitedHeight property is ignored when NewPage method is called.
	IsCrossBandsMode	This property is set to true for printing CrossBands.
	IsDynamicBookmarksMode	If true then it is allowed to add any Bookmarks. If false then add Bookmarks of components which the IsRendered property = false (in other words it is rendered first time). This property allows adding Bookmarks for static components only once (to avoid duplication).
	IsFirstDataBandOnPage	Returns true if the first DataBand is printed on the current page.
	IsLastDataBandOnPage	Returns true if the last DataBand is printed on the current page.
	MasterReport	Gets or sets a master report that is being rendered in the current moment.
	Page	Gets or sets a page in what rendering of bands is done.
	PositionBottomY	Indicates the current position bands output on the Y axis on the bottom of a page.
	PositionX	Indicates the current position bands output on the X axis.
	PositionY	Indicates the current position bands output on the Y axis.
	Report	Gets or sets a report that is being rendered in the current moment.
	TemplateContainer	Gets or sets a container from a template. This page is being rendered in the current moment. If a page is output then the TemplateContainer property is equal in TemplatePage.
	TemplatePage	Gets or sets a page from a template. This page is being rendered in the current moment.

Internal Fields

	Name	Description
	AllowEndOfPageProcessing	This is AllowEndOfPageProcessing, a member of class StiEngine.
	anchorsArguments	This is anchorsArguments, a member of class StiEngine.
	atLeastOneDatabandRenderedOnPage	This is atLeastOneDatabandRenderedOnPage, a member of class StiEngine.
	bandsInProgress	This is bandsInProgress, a member of class StiEngine.
	DenyClearPrintOnAllPagesIgnoreList	Флаг устанавливается во время рендеринга StiBandsOnAllPages для того, чтобы датабэнды, которые выводятся на каждой странице, не обнуляли этот список
	duplilcatesLastValues	This is duplilcatesLastValues, a member of class StiEngine.
	FirstCallNewPage	Флаг устанавливается каждый раз для новой страницы шаблона. Это гарантирует, что страница со включенным свойством UnlimitedHeight начнет рендериться на новой странице а не добавит сегменты к предыдущей странице
	generateNewColumnBeforeBand	Requires to generate a new column before the next band. A flag is used to prevent empty columns after a band. A new column is not generated after the specified band but not before the next band. If there is no the next band then there is no a new column.
	generateNewPageBeforeBand	It is required to generate a new page before the next band. A flag is used to prevent empty pages after a band. A new page is not generated after the specified band but not before the next band. If there is no the next band then there is no a new page.
	hashCheckSize	This is hashCheckSize, a member of class StiEngine.
	hashDataSourceReferencesCounter	This is hashDataSourceReferencesCounter, a member of class StiEngine.
	hashParentStyles	This is hashParentStyles, a member of class StiEngine.
	ignoreSkipFirst	If true then the engine should ignore the value of the SkipFirst property of a band. It is necessary if NewPageAfter or NewColumnAfter are processed.
	IndexOfLatestDataBand	An index of the last rendered DataBand. The Index is used to put the AddLevel before this DataBand and make KeepFooterTogether properties work correct.
	IndexOfStartList	Contains an index that indicates a position of the beginning the current column output. If there are no columns then contains 0.
	IndexPageForPageTotal	Contain index of page for page total calculation.
	lastFreeSpaceOnPageAfterNewList	This is lastFreeSpaceOnPageAfterNewList, a member of class StiEngine.
	lastInvokeTextProcessValueEventArgsValue	This is lastInvokeTextProcessValueEventArgsValue, a member of class StiEngine.
	latestProgressValue	This is latestProgressValue, a member of class StiEngine.
	offsetNewColumnY	This is offsetNewColumnY, a member of class StiEngine.
	pageBreakSkipFirstCollection	Коллекция служит для определения случая пропуска генерации новой страницы или новой колонки при помощи свойства SkipFirst. Если бэнд уже пропускал один раз генерацию новой страницы или колонки, то он заносится в эту коллекцию.
	RenderState	Contains an information that is necessary to show progress of report rendering.
	SilentMode	If a variable is true then output as a band is not done.
	skipFirstPageBeforePrintEvent	Флаг служит для игнорирования первого BeforePrintEvent для страницы, так как это событие вызывается ранее при первом обращении к шаблону страницы
	StartIndexPageForPageTotal	Contain start index of page for page total calculation. Used for running total

Internal Properties

	Name	Description
	BandsOnAllPages	Contains a collection of bands which should be output on all pages.
	Breakable	An object helps to work with IStiBreakable interface.
	ColumnsOnDataBand	Used to output columns on the DataBand.
	ColumnsOnPanel	Used to output columns on the Panel.
	DenyChangeThread	If true then it is impossible to change stream of printing.
	DenyRenderMasterComponentsInContainer	If true then the Render method of a container will not render components of the Master type. This property is used with the RenderSimpleComponents method of a page. It is used to deny master components and render simple ones.
	EmptyBands	Used to output EmptyBands in the current container.
	FootersOnAllPages	Cotnains a collection of Footers which should be output on the bottom of a page. The list is filled when stream rendering and the list is cleared when rendering of the current stream is finished.
	hashUseParentStyles	This is hashUseParentStyles, a member of class StiEngine.
	KeepFirstDetailTogetherList	Contains a list of stored bands for keepFirstDetailTogether property
	KeepFirstDetailTogetherTablesList	Contains a list of bands created from the tables.
	MasterEngine	If an engine is slave then this reference indicates the parent report engine.
	PageNumbers	This is PageNumbers, a member of class StiEngine.
	parserConversionStore	This is parserConversionStore, a member of class StiEngine.
	PrintAtBottom	Contains a collection of bands which should be output on the bottom of a page. The list is filled when stream rendering and the list is cleared when rendering of the current stream is finished.
	PrintOnAllPagesIgnoreList	Contains the list of bands which should be passed when rendering.
	ProgressHelper	A class helps to output the progress bar when report rendering.
	SlaveEngines	Contains a list of Slave Engines.
	StaticBands	An object helps to output static bands on a page.
	Threads	This object helps to print groups of bands from containers which are placed directly on a page.

Made with Doc-O-Matic.

What do you think about this topic? Send feedback!