Reports for WinForms | ComponentOne
C1.C1Report.4 Assembly / C1.C1Preview Namespace / RenderObject Class
Properties Methods


In This Topic
    RenderObject Class Members
    In This Topic

    The following tables list the members exposed by RenderObject.

    Public Properties
     NameDescription
    Public PropertyAnchorsGets the collection of anchors (elements of the type C1Anchor) associated with the current object.  
    Public PropertyBordersSplitHorzModeGets or sets a value indicating how borders are drawn if the object is too wide and is split between horizontal pages.  
    Public PropertyBordersSplitVertModeGets or sets a value indicating how borders are drawn if the object is too high and is split between pages.  
    Public PropertyBreakAfterGets or sets the type of break (none, line, column, or page) to insert after the current object.  
    Public PropertyBreakBeforeGets or sets the type of break (none, line, column, or page) to insert before the current object.  
    Public PropertyCanSplitHorzIndicates whether the object can be split horizontally if it falls on a page break.  
    Public PropertyCanSplitVertIndicates whether the object can be split vertically if it falls on a page break.  
    Public PropertyChildrenGets the collection of child render objects.  
    Public PropertyClipGets or sets the value indicating whether the object should be clipped.  
    Public PropertyCollectionGets the RenderObjectCollection containing the current object, or null if the current object has no IOwnedCollectionItem.Owner or the owner is not a RenderObjectCollection.  
    Public PropertyCopiesGets the collection of RenderObject objects generated by data binding. The value of this property is null if the object is not data bound.  
    Public PropertyDataBindingGets an instance of C1.C1Preview.DataBinding.C1DataBinding class representing the data binding properties of the current object.  
    Public PropertyDataBindingDefinedGets a value indicating whether the current object is data bound. Returns true if the object's DataBinding property has been initialized and its C1.C1Preview.DataBinding.C1DataBinding.Mode is not DataBindingModeEnum.None.  
    Public PropertyDataBindingModeGets a combination of DataBindingModeEnum flags specifying the data binding mode of the current object.  
    Public PropertyDocumentGets the C1PrintDocument object containing the current RenderObject.  
    Public PropertyFireProgressEventTBD: 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.  
    Public PropertyFirstFragmentGets the first fragment of the current object, or null if Fragments has not been initialized yet.  
    Public PropertyFormatDataBindingInstanceScriptGets or sets a script that is executed each time a new instance of the current RenderObject is created due to data binding resolving.  
    Public PropertyFragmentResolvedScriptGets 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.  
    Public PropertyFragmentsGets a RenderFragmentCollection containing the fragments produced by the current object in the generated document.  
    Public PropertyHasAnchorsGets a value indicating whether the current object has any anchors associated with it (i.e. whether the Anchors collection exists and is not empty).  
    Public PropertyHasChildrenGets a value indicating whether the current object has children (i.e. its Children collection contains at least one element).  
    Public PropertyHasFragmentsGets a value indicating whether the current object's Fragments collection has been initialized and contains one or more fragments.  
    Public PropertyHeightGets or sets the height of the current object.

    May be specified as auto (Unit.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").

     
    Public PropertyHyperlinkGets or sets the hyperlink (see C1Hyperlink) associated with the current object.  
    Public PropertyIndexInOwnerGets the index of the current object within the IOwnedCollectionItem.Owner, or -1 if there is no owner.  
    Public PropertyKeepTogetherGets 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.  
    Public PropertyLastFragmentGets the last fragment of the current object, or null if Fragments has not been initialized yet.  
    Public PropertyLayoutChangeAfterGets or sets the LayoutChangeBase object defining the change of page layout that will occur after the current object.  
    Public PropertyLayoutChangeBeforeGets or sets the LayoutChangeBase object defining the change of page layout that will occur before the current object.  
    Public PropertyNameGets 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 IOwnedCollectionItem.Owner).  
    Public PropertyObjectResolvedScriptGets 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.  
    Public PropertyObjectResolvingScript  
    Public PropertyOriginalGets the original RenderObject object that produced the current object during data binding, or null if there is no such object.  
    Public PropertyPageNumberingChangeGets or sets the PageNumberingChange object defining the page numbering change that will occur when the current object is rendered.  
    Public PropertyParentGets the parent RenderObject containing the current object.  
    Public PropertySplitHorzBehaviorGets 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.  
    Public PropertySplitVertBehaviorGets 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.  
    Public PropertyStackingGets or sets the stacking rules used to arrange the children of the current object.  
    Public PropertyStyleGets 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 Style.Parent to that other style.  
    Public PropertyTableGets the most nested RenderTable containing the current render object, or null if the current object is not contained in a table.  
    Public PropertyTableCellGets the TableCell object containing the current object, or null if the current object is not contained in a cell of a RenderTable.  
    Public PropertyTableColGets 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.  
    Public PropertyTableRowGets 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.  
    Public PropertyUserDataGets or sets arbitrary data associated with the current object.  
    Public PropertyVisibilityGets or sets a value indicating the visibility of the current object.  
    Public PropertyWidthGets or sets the width of the current object.

    May be specified as auto (Unit.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)").

     
    Public PropertyXGets or sets the X coordinate of the current object.

    May be specified as auto (Unit.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").

     
    Public PropertyYGets or sets the Y coordinate of the current object.

    May be specified as auto (Unit.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").

     
    Public PropertyZOrderGets 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.  
    Top
    Protected Properties
     NameDescription
    Protected PropertyCalculatedValuesGets the hashtable containing the calculated values.  
    Protected PropertyHasCalculatedValuesGets a value indicating whether the CalculatedValues hashtable exists and is not empty.  
    Protected Propertym_FlagsFor internal use.  
    Top
    Public Methods
     NameDescription
    Public MethodAssignFromOverloaded. 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.  
    Public MethodCalcSizeCalculates 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.  
    Public MethodCloneOverloaded. Clones the current RenderObject.  
    Public MethodGetNestedObjectCountCalculates the count of objects which are nested within this object. This method takes into account child objects and their children.  
    Public MethodGetOwnedObjectCountCalculates the number of objects which are owned by the current object.  
    Public MethodIndexOfFragmentReturns the index of the specified RenderFragment of the current object in the Fragments collection.  
    Top
    Protected Methods
     NameDescription
    Protected MethodCreateDataBindingCopyFor internal use.  
    Protected MethodCreateSameCreates instance of object same type as current RenderObject object.  
    Protected MethodGetAmbientPropValueForChildGets the value of a child's ambient style property.  
    Protected MethodGetAssignChildrenOverride this method and return false if you want manually copy of children objects for this object. This method returns true by default.  
    Protected MethodGetDataBindingForChildReturns the C1.C1Preview.DataBinding.C1DataBinding object for a specified child object.  
    Protected MethodGetDefaultClipGets the default value for the Clip property.  
    Protected MethodGetDefaultFlagsGets the default value for the Flags property.  
    Protected MethodGetDefaultHeightGets the default value for the Height property.  
    Protected MethodGetDefaultSplitHorzBehaviorGets the default value for the SplitHorzBehavior property.  
    Protected MethodGetDefaultSplitVertBehaviorGets the default value for the SplitVertBehavior property.  
    Protected MethodGetDefaultWidthGets the default value for the Width property.  
    Protected MethodGetDocumentLocationDescriptionReturns a human-readable textual description of the location of the current object in the document.  
    Protected MethodGetFlagReturns 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); } }  
    Protected MethodGetHeightOverride this method to perform additional actions when value of the Height property of object is being read.  
    Protected MethodGetNonAmbientPropValueForChildGets the value of a child's non-ambient style property.  
    Protected MethodGetProcessChildrenWhenDataBindingResolvedIndicates 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.  
    Protected MethodGetWidthOverride this method to perform additional actions when value of the Width property of object is being read.  
    Protected MethodInitRenderObjectPerforms some initializations.  
    Protected MethodInternalResetLayoutDimensionsFor internal use only.  
    Protected MethodInternalResolveCalculatedValuesResolves the values of calculated fields of object.  
    Protected MethodInternalResolveStylesResolves the calculated values of object's style.  
    Protected MethodInternalResolvingFinishedThis 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.  
    Protected MethodOnMainFragmentBuiltThis method is called once for each object, override it to perform custom initialization.  
    Protected MethodResolveChildrenDataBindingInternal use only.  
    Protected MethodSetFlagSets value of flag.  
    Protected MethodSetHeightOverride this method to perform additional actions when value of the Height property of object is being defined.  
    Protected MethodSetSplitHorzBehaviorOverride this method to perform additional actions when value of the SplitHorzBehavior property of object is being defined.  
    Protected MethodSetSplitVertBehaviorOverride this method to perform additional actions when value of the SplitVertBehavior property of object is being defined.  
    Protected MethodSetWidthOverride this method to perform additional actions when value of the Width property of object is being defined.  
    Protected MethodShouldSerializeChildrenTests whether the Children property should be serialized.  
    Protected MethodShouldSerializeClipTests whether the Clip property should be serialized.  
    Protected MethodShouldSerializeFlagsTests whether the Flags property should be serialized.  
    Protected MethodShouldSerializeHeightTests whether the Height property should be serialized.  
    Protected MethodShouldSerializeNameTests whether the Name property should be serialized.  
    Protected MethodShouldSerializeSplitHorzBehaviorTests whether the SplitHorzBehavior property should be serialized.  
    Protected MethodShouldSerializeSplitVertBehaviorTests whether the SplitVertBehavior property should be serialized.  
    Protected MethodShouldSerializeStyleTests whether the Style property should be serialized.  
    Protected MethodShouldSerializeWidthTests whether the Width property should be serialized.  
    Protected MethodShouldSerializeXTests whether the X property should be serialized.  
    Protected MethodShouldSerializeYTests whether the Y property should be serialized.  
    Top
    See Also

    Reference

    RenderObject Class
    C1.C1Preview Namespace