[]
        
(Showing Draft Content)

C1.C1Preview.RenderFragment

RenderFragment Class

Represents a fragment of a RenderObject in a resolved C1PrintDocument.

Implements
Namespace: C1.C1Preview
Assembly: C1.PrintDocument.8.dll
Syntax
[C1ClassSerialization(true)]
public abstract class RenderFragment : IDocumentLocation

Properties

Name Description
Bounds

Gets or sets the current fragment's bounds within its parent. For top level fragments, bounds within Page are returned.

BoundsOnPage

Gets the bounds of the current fragment on the page.

Children

Gets a RenderFragmentCollection containing the child fragments of the current fragment.

ChildrenAlwaysCanSplitHorz

For internal use.

ChildrenAlwaysCanSplitVert

For internal use.

ClipParent

Gets the value indicating whether the parent object is clipped. (Returns the value of ClipPage for top-level fragments, Clip of the parent fragment's render object for nested ones.)

ColumnIndex

Gets the 0-based index of the column on the page containing the current fragment. For the default single-column page layout, the value of this property is 0. If the current fragment belongs to a page header or footer, this value is -1 (see IsInPageHeader and IsInPageFooter).

ContentBoundsOnPage

For internal use.

Document

Gets the C1PrintDocument object containing the current fragment.

DrawBoundsOnPage

For internal use.

HasChildren

Gets a value indicating whether the Children collection of the current fragment has been initialized and contains one or more elements.

IndexInParent

Gets the 0-based index of the current fragment in the Children collection of its Parent.

IndexInRenderObject

Gets the 0-based index of the current fragment in the Fragments collection of the RenderObject that produced it.

InnerBounds

Gets the inner bounds of the current fragment (without spacing, borders and padding) within its parent.

InnerBoundsOnPage

Gets the inner bounds of the current fragment (without spacing, borders and padding) on the page.

IsInPageFooter

Gets a value indicating whether the current fragment belongs to the page footer.

IsInPageHeader

Gets a value indicating whether the current fragment belongs to the page header.

Level

Gets the nesting level of the current fragment in the fragments' tree. The topmost fragment (that has no parent) has level 1.

Page

Gets the page containing the current fragment.

PageIndex

Gets the 0-based index of C1Page containing the current fragment.

Parent

Gets RenderFragment that is the parent of the current fragment.

RenderObject

Gets the RenderObject that produced the current fragment.

TableColOnPage

Gets the 0-based index of the column in the most nested RenderTableFragment containing the current render object (i.e. the column index on the current page), or -1 if the current object is not contained in a table.

TableFragment

Gets the most nested RenderTableFragment containing the current fragment, or null if the current object is not contained in a table.

TableRowOnPage

Gets the 0-based index of the row in the most nested RenderTableFragment containing the current render object (i.e. the row index on the current page), or -1 if the current object is not contained in a table.

TopParent

Gets the top level RenderFragment containing the current fragment.

Visible

Gets a value indicating whether the current fragment is visible.

Methods

Name Description
AssignFrom(RenderFragment)

Assigns (copies) properties from another RenderFragment to the current object. Clones Children by cloning all its elements.

CalcLength(RefDim)

This method can be called only by another RenderFragment object during resolving LengthRef object.

CalcLength(RefDim, LengthBase, bool, out PageAreaBase, out double)

Calculates a value of dimension. Only LengthRef, LengthAbs, LengthExp can be specified as length.

CalcLengthAbs(RefDim, LengthAbs, bool, out PageAreaBase, out double)

Calculates a value of dimension specified by LengthAbs.

CalcLengthExp(RefDim, LengthExp, bool, out PageAreaBase, out double)

Calculates a value of dimension specified by the LengthExp object. (dimension is an expression).

CalcLengthRef(RefDim, LengthRef, bool, out PageAreaBase, out double)

Calculates a value of dimension specified by the LengthRef object. (dimension references a dimension of another object).

ChangeResolvedDimensions(double, double, double, double)

Called when the resolved sizes of the object should be changed, for example when resolving of table is finished and height of all objects in a row is set to the same value. Object may ignore this changing and not change self size. This method is called only for child objects, so x and y are relative to the top left corner of the parent.

Clone()

Creates a copy of the current RenderFragment.

CreateSame()

Creates instance of object same type as current RenderFragment object.

CreateSplitParams()

Creates a SplitParams object, used during splitting, child classes may override this method to create the SplitParams object of custom type (derived from SplitParams).

Draw(Graphics, bool)

Draws the current fragment and its children on a specified Graphics.

Draw(Graphics, Rectangle, bool)

Draws the current fragment and its children on a specified Graphics.

Draw(Graphics, Rectangle, bool, bool)

Draws the current fragment and its children on a specified Graphics.

Draw(Graphics, Rectangle, Rectangle, bool, PageDrawParams)

Draws the current fragment on a specified Graphics.

Draw(Graphics, Rectangle, Rectangle, bool, bool, bool)

Draws the current fragment on a specified Graphics.

DrawBackground(Graphics, Rectangle)

Draws background of object.

DrawBorders(Graphics, Rectangle, OffsetsI, PageDrawParams)

Draws borders of object.

DrawChildren(Graphics, DrawParams)

For internal use.

DrawContent(Graphics, DrawParams)

For internal use.

FillRect(Graphics, Rectangle, Style, IScriptContext)

For internal use.

FillRect(Graphics, int, int, int, int, Style, IScriptContext)

For internal use.

FindHorzSplitPosContent(SplitParams)

Checks can object's content be split on specified position by horizontally.

Searches for a C1Hyperlink object in the current fragment at the specified position.

FindVertSplitPosContent(SplitParams)

Checks can object's content be split on specified position by vertically.

GetAnchorRect(C1Anchor, ref RectangleD, ref bool)

Calculates the location of a C1Anchor contained in the Anchors collection of the render object that produced the current fragment.

GetChildrenDrawBounds(RenderFragment, Graphics, DrawParams)

For internal use.

GetContentAutoHeight(double, ref double)

Override this method to calculate the height of object on basis of its content, this method is called when height of object specified as auto, for example:

obj.Height = Unit.Auto;
GetContentAutoSize(ref double, ref double)

Override this method to calculate sizes of object on basis of its content, this method is called when width and height of object specified as auto.

GetContentAutoWidth(double, ref double)

Override this method to calculate the width of object on basis of its content, this method is called when width of object specified as auto, for example:

obj.Width = Unit.Auto;
GetDrawingFlags(bool)

Override this method to define the drawing flags. These flags manage the object's painting. C1.C1Preview.DrawingFlagsEnum

GetFlag(int)

For internal use.

GetHorzSplits(List<double>)

Override this method and return the horizontal splits in the object relative to the left edge of the content area.

Adds information about all hyperlinks that appear in the current fragment to a C1HyperlinkInfoCollection.

GetReferencedObject(RefDim, LengthRef)

Gets the object referenced by a C1.C1Preview.LengthRef object. Called only from ResolveLengthRef(RefDim, LengthRef).

GetRoundBorderClipping(Graphics, Rectangle, OffsetsI, DrawingFlagsEnum, out GraphicsPath, out nint)

Retures GraphicsPath object representing the rounded object's border, if border is not rounded returns nil.

GetVertSplits(List<double>)

Override this method and return the vertical splits in the object relative to the top top edge of the content area.

HasClippedChildren(bool)

Checks whether any of the child fragments of the current fragment are clipped by its bounds. Depending on the recursive parameter, may also recursively test all child fragments.

InitializeSplitParams(bool, SplitPos, SplitContext)

For internal use.

InternalDraw(GdiDc, DrawParams)

Override this procedure if GetDrawingFlags sets the DrawingFlagsEnum.UseGdiDrawing flag.

InternalDraw(Graphics, DrawParams)

Override this procedure if GetDrawingFlags does not set the DrawingFlagsEnum.UseGdiDrawing flag.

InternalDrawShadow(Graphics, DrawParams)

For internal use only.

InternalPrepareForReresolving(FragmentResolvedInfo, FragmentResolvedInfo, SplitParams, ref bool)

Override this method to perform additional initializations of resolved info of object on reresolving. Some dimensions of object do not change when it splits, so you can use this method to copy some information from old resolved info to new resolved info.

IsReresolvingNeeded(PageAreaBase, double, double, double, double)

Gets a value indicating whether a full re-resolving of the whole render object is needed.

IsShadowVisible()

Returns true if shadow visible for RenderFragment.

ResolveChildrenLayout(LengthBase, LengthBase)

For internal use.

ResolveLength(RefDim, LengthBase)

For internal use.

ResolveLengthAbs(RefDim, LengthAbs)

Resolves an absolute dimension of object.

ResolveLengthAuto(RefDim, LengthAuto)

Resolves an auto dimension of object.

ResolveLengthExp(RefDim, LengthExp)

Resolves a expression dimension of object.

ResolveLengthRef(RefDim, LengthRef)

Resolves a dimension of object specified as reference.

ResolvingFinished()

This method is called by the rendering engine after the current RenderFragment has been completely resolved. Typically this method would be used to clear temporary data created and used during resolving.

SetFlag(int, bool)

For internal use.

ShouldSerializeBorders()

Indicates whether the C1.C1Preview.RenderFragment.Borders property should be serialized.

ShouldSerializeDrawInner()

Indicates whether the C1.C1Preview.RenderFragment.DrawInner property should be serialized.

ShouldSerializePadding()

Indicates whether the C1.C1Preview.RenderFragment.Padding property should be serialized.

ShouldSerializeSpacing()

Indicates whether the C1.C1Preview.RenderFragment.Spacing property should be serialized.

Split(RenderFragment, SplitParams)

Performs splitting of RenderFragment object.

SplitChildren(RenderFragment, SplitParams, double, double, double)

For internal use.

SplitHorzContent(RenderFragment, SplitParams)

Splits content of object by horizontally, by default this procedure split object as image.

SplitVertContent(RenderFragment, SplitParams)

Splits content of object by vertically, by default this procedure split object as image.