RenderObject Class

The abstract base class for all render objects representing content of a C1PrintDocument.

Inheritance

object

RenderObject

Implements

IStyleOwner

IDocumentLocation

Namespace: C1.C1Preview

Assembly: C1.PrintDocument.10.dll

Syntax

[C1ClassSerialization(true)]
public abstract class RenderObject : IStyleOwner, IDocumentLocation

<C1ClassSerialization(True)>
Public MustInherit Class RenderObject
    Implements IStyleOwner, IDocumentLocation

Constructors

Name	Description
RenderObject()	Initializes a new instance of the RenderObject class.

Properties

Name	Description
Anchors	Gets the collection of anchors (elements of the type C1Anchor) associated with the current object.
BordersSplitHorzMode	Gets or sets a value indicating how borders are drawn if the object is too wide and is split between horizontal pages.
BordersSplitVertMode	Gets or sets a value indicating how borders are drawn if the object is too high and is split between pages.
BreakAfter	Gets or sets the type of break (none, line, column, or page) to insert after the current object.
BreakBefore	Gets or sets the type of break (none, line, column, or page) to insert before the current object.
CalculatedValues	Gets the hashtable containing the calculated values.
CanSplitHorz	Indicates whether the object can be split horizontally if it falls on a page break.
CanSplitVert	Indicates whether the object can be split vertically if it falls on a page break.
Children	Gets the collection of child render objects.
Clip	Gets or sets the value indicating whether the object should be clipped.
Collection	Gets the RenderObjectCollection containing the current object, or null if the current object has no C1.C1Preview.IOwnedCollectionItem.Owner or the owner is not a RenderObjectCollection.
Copies	Gets the collection of RenderObject objects generated by data binding. The value of this property is null if the object is not data bound.
DataBinding	Gets an instance of C1DataBinding class representing the data binding properties of the current object.
DataBindingDefined	Gets a value indicating whether the current object is data bound. Returns true if the object's DataBinding property has been initialized and its Mode is not None.
DataBindingMode	Gets a combination of DataBindingModeEnum flags specifying the data binding mode of the current object.
Document	Gets the C1PrintDocument object containing the current RenderObject.
FireProgressEvent	TBD: Gets or sets a value indicating whether progress events should be generated during resolving of this render object. This property is false by default, you can set this property to true if object is large and its resolving take a long of time, to suppress hangup time during document rendering.
FirstFragment	Gets the first fragment of the current object, or null if Fragments has not been initialized yet.
FormatDataBindingInstanceScript	Gets or sets a script that is executed each time a new instance of the current RenderObject is created due to data binding resolving.
FragmentResolvedScript	Gets or sets the script that is executed each time a RenderFragment of the current render object is created and added to the Fragments collection on the current object.
Fragments	Gets a RenderFragmentCollection containing the fragments produced by the current object in the generated document.
HasAnchors	Gets a value indicating whether the current object has any anchors associated with it (i.e. whether the Anchors collection exists and is not empty).
HasCalculatedValues	Gets a value indicating whether the CalculatedValues hashtable exists and is not empty.
HasChildren	Gets a value indicating whether the current object has children (i.e. its Children collection contains at least one element).
HasFragments	Gets a value indicating whether the current object's Fragments collection has been initialized and contains one or more fragments.
Height	Gets or sets the height of the current object. May be specified as auto (Auto), a percentage of the parent's height (e.g. "50%"), an absolute value (using DefaultUnit), an absolute value with unit of measurement (e.g. "12mm"), or an expression referencing this and other objects (e.g. "150%prev.height+1in").
Hyperlink	Gets or sets the hyperlink (see C1Hyperlink) associated with the current object.
IndexInOwner	Gets the index of the current object within the C1.C1Preview.IOwnedCollectionItem.Owner, or -1 if there is no owner.
KeepTogether	Gets or sets a render object which should be printed on the same page as the current object. The specified object must have the same Parent as the current object.
LastFragment	Gets the last fragment of the current object, or null if Fragments has not been initialized yet.
LayoutChangeAfter	Gets or sets the LayoutChangeBase object defining the change of page layout that will occur after the current object.
LayoutChangeBefore	Gets or sets the LayoutChangeBase object defining the change of page layout that will occur before the current object.
Name	Gets or sets the name of the current object. The name can be an empty string. If it is not empty, the name must be unique among the current object's siblings (i.e. objects with the same C1.C1Preview.IOwnedCollectionItem.Owner).
ObjectResolvedScript	Gets or sets the script that is executed when the current object has been completely resolved, all its fragments created and added to the Fragments collection of the current object.
ObjectResolvingScript	Gets or sets the script that is executed before resolving the current object.
Original	Gets the original RenderObject object that produced the current object during data binding, or null if there is no such object.
PageNumberingChange	Gets or sets the PageNumberingChange object defining the page numbering change that will occur when the current object is rendered.
Parent	Gets the parent RenderObject containing the current object.
SplitHorzBehavior	Gets or sets the value determining how the object is treated when it is too wide to fit in the horizontal space available on the current page.
SplitVertBehavior	Gets or sets the value determining how the object is treated when it is too high to fit in the vertical space available on the current page.
Stacking	Gets or sets the stacking rules used to arrange the children of the current object.
Style	Gets the Style of the current object. This property cannot be assigned to. To use another style as the base for the current object's style, set the Parent to that other style.
Table	Gets the most nested RenderTable containing the current render object, or null if the current object is not contained in a table.
TableCell	Gets the TableCell object containing the current object, or null if the current object is not contained in a cell of a RenderTable.
TableCol	Gets the 0-based index of the column in the most nested RenderTable containing the current render object, or -1 if the current object is not contained in a table.
TableRow	Gets the 0-based index of the row in the most nested RenderTable containing the current render object, or -1 if the current object is not contained in a table.
UserData	Gets or sets arbitrary data associated with the current object.
Visibility	Gets or sets a value indicating the visibility of the current object.
Width	Gets or sets the width of the current object. May be specified as auto (Auto), a percentage of the parent's width (e.g. "50%"), an absolute value (using DefaultUnit), an absolute value with unit of measurement (e.g. "12mm"), or an expression referencing this and other objects (e.g. "Max(prev.width,6cm)").
X	Gets or sets the X coordinate of the current object. May be specified as auto (Auto), an absolute value (using DefaultUnit), an absolute value with unit of measurement (e.g. "12mm"), or an expression referencing this and other objects (e.g. "prev.right+2mm").
Y	Gets or sets the Y coordinate of the current object. May be specified as auto (Auto), an absolute value (using DefaultUnit), an absolute value with unit of measurement (e.g. "12mm"), or an expression referencing this and other objects (e.g. "prev.height/2-self.height/2").
ZOrder	Gets or sets the Z-order of the current object. Objects with smaller Z-order values are drawn under objects with larger Z-order values. By default, this property is zero.
m_Flags	For internal use.

Methods

Name	Description
AssignFrom(RenderObject)	Assigns (copies) properties from another RenderObject to the current object. The list of fragments (the Fragments property) is neither copied nor changed. Properties UserData, PageNumberingChange are copied by reference. The Name property is not copied.
AssignFrom(RenderObject, bool, bool)	Assigns (copies) properties from another RenderObject to the current object. The list of fragments (the Fragments property) is neither copied nor changed. Properties UserData, PageNumberingChange are copied by reference. The Name property is not copied.
AssignFrom(RenderObject, bool, bool, bool, bool)	Assigns (copies) properties from another RenderObject to the current object. The list of fragments (the Fragments property) is neither copied nor changed. Properties UserData, PageNumberingChange are copied by reference. The Name property is not copied.
AssignFrom(RenderObject, bool, bool, bool, bool, bool, bool)	Assigns (copies) properties from another RenderObject to the current object. The list of fragments (the Fragments property) is neither copied nor changed. Properties UserData, PageNumberingChange are copied by reference. The Name property is not copied.
CalcSize(Unit, Unit)	Calculates the size of the current object. When this method is called, the object must already have been added to the document (e.g. to Body or to Children of another object in the document). See remarks for more details.
Clone()	Clones the current RenderObject.
Clone(bool, bool)	Clones the current RenderObject.
Clone(bool, bool, bool, bool)	Clones the current RenderObject.
Clone(bool, bool, bool, bool, bool, bool)	Clones the current RenderObject.
CreateDataBindingCopy(OutlineNode)	For internal use.
CreateSame()	Creates instance of object same type as current RenderObject object.
GetAmbientPropValueForChild(RenderObject, int, IScriptContext)	Gets the value of a child's ambient style property.
GetApproximateCountOfFragmentsToProcess()	Returns the approximate count of fragments in the current object (used to show progress during document generation).
GetAssignChildren()	Override this method and return false if you want manually copy of children objects for this object. This method returns true by default.
GetCalculatedValue(int)	For internal use.
GetCalculatedValue(int, out object)	For internal use.
GetDataBindingForChild(RenderObject)	Returns the C1DataBinding object for a specified child object.
GetDefaultClip()	Gets the default value for the Clip property.
GetDefaultFlags()	Gets the default value for the Flags property.
GetDefaultHeight()	Gets the default value for the Height property.
GetDefaultSplitHorzBehavior()	Gets the default value for the SplitHorzBehavior property.
GetDefaultSplitVertBehavior()	Gets the default value for the SplitVertBehavior property.
GetDefaultWidth()	Gets the default value for the Width property.
GetDocumentLocationDescription()	Returns a human-readable textual description of the location of the current object in the document.
GetFlag(int)	Returns the value of flag. The object has private field: `private int _flags;` This field can be used for storing various boolean properties (CanSplitHorz, CanSplitVert etc), for example CanSplitHorz property defined as: `public bool CanSplitHorz { get { return GetFlag(c_flgCanSplitVert); } set { SetFlag(c_flgCanSplitVert, value); } }`
GetHeight()	Override this method to perform additional actions when value of the Height property of object is being read.
GetNestedObjectCount()	Calculates the count of objects which are nested within this object. This method takes into account child objects and their children.
GetNonAmbientPropValueForChild(RenderObject, int, IScriptContext)	Gets the value of a child's non-ambient style property.
GetOwnedObjectCount()	Calculates the number of objects which are owned by the current object.
GetProcessChildrenWhenDataBindingResolved()	Indicates whether to automatically process data binding on child objects. The default implementation returns true, override it and return false if custom child data binding processing is required.
GetWidth()	Override this method to perform additional actions when value of the Width property of object is being read.
HasCalculatedValue(int)	For internal use.
IndexOfFragment(RenderFragment)	Returns the index of the specified RenderFragment of the current object in the Fragments collection.
InitRenderObject()	Performs some initializations.
InternalClearCalculatedValues(bool)	Clears the values of calculated properties, called when a document is regenerated.
InternalClearTemporaryInfo()	Clears temporary information created during document resolving. Override this method to clear render object type-specific data (but call the base method to clear common data).
InternalResetLayoutDimensions(RefDim)	For internal use only.
InternalResolveCalculatedValues()	Resolves the values of calculated fields of object.
InternalResolveStyles()	Resolves the calculated values of object's style.
InternalResolvingFinished()	This method is called once after the current RenderObject has been fully resolved. At the time of the call all RenderFragment objects a built and placed on their pages. Override it to perform custom processing at that time.
OnChildAdd(RenderObject)	Called after adding new child RenderObject object to the Children collection. User can throw exception if this object can't be added as the child for this object.
OnChildRemove(RenderObject)	Called after removing child RenderObject object from the Children collection. User can throw exception if this object can't be removed.
OnMainFragmentBuilt()	This method is called once for each object, override it to perform custom initialization.
OnParentAdd(RenderObject)	Called after adding this object to the Children collection of another object. User can throw exception if this object can't be added as the child for this object.
OnParentRemove(RenderObject)	Called after removing this object from the Children collection of another object.
ResolveChildrenDataBinding(RenderObject, OutlineNode)	Internal use only.
ResolveStyleProperties(Style, Style)	For internal use only. Resolves calculated properties of the Style object.
SetCalculatedValue(int, object)	For internal use.
SetCalculatedValue(int, object, bool)	For internal use.
SetFlag(int, bool)	Sets value of flag. GetFlag(int)
SetHeight(Unit)	Override this method to perform additional actions when value of the Height property of object is being defined.
SetSplitHorzBehavior(SplitBehaviorEnum)	Override this method to perform additional actions when value of the SplitHorzBehavior property of object is being defined.
SetSplitVertBehavior(SplitBehaviorEnum)	Override this method to perform additional actions when value of the SplitVertBehavior property of object is being defined.
SetWidth(Unit)	Override this method to perform additional actions when value of the Width property of object is being defined.
ShouldSerializeChildren()	Tests whether the Children property should be serialized.
ShouldSerializeClip()	Tests whether the Clip property should be serialized.
ShouldSerializeFlags()	Tests whether the Flags property should be serialized.
ShouldSerializeHeight()	Tests whether the Height property should be serialized.
ShouldSerializeName()	Tests whether the Name property should be serialized.
ShouldSerializeSplitHorzBehavior()	Tests whether the SplitHorzBehavior property should be serialized.
ShouldSerializeSplitVertBehavior()	Tests whether the SplitVertBehavior property should be serialized.
ShouldSerializeStyle()	Tests whether the Style property should be serialized.
ShouldSerializeWidth()	Tests whether the Width property should be serialized.
ShouldSerializeX()	Tests whether the X property should be serialized.
ShouldSerializeY()	Tests whether the Y property should be serialized.