PrintDocument for WinForms | ComponentOne
C1.PrintDocument.8 Assembly / C1.C1Preview Namespace / RenderTocItem Class
Properties Methods


In This Topic
    RenderTocItem Class Members
    In This Topic

    The following tables list the members exposed by RenderTocItem.

    Public Constructors
     NameDescription
    Public ConstructorInitializes a new instance of the RenderTocItem class.  
    Top
    Public Properties
     NameDescription
    Public PropertyGets the collection of anchors (elements of the type C1Anchor) associated with the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets a value indicating how borders are drawn if the object is too wide and is split between horizontal pages. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets a value indicating how borders are drawn if the object is too high and is split between pages. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the type of break (none, line, column, or page) to insert after the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the type of break (none, line, column, or page) to insert before the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyIndicates whether the object can be split horizontally if it falls on a page break. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyIndicates whether the object can be split vertically if it falls on a page break. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the collection of child render objects. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the value indicating whether the object should be clipped. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the RenderObjectCollection containing the current object, or null if the current object has no IOwnedCollectionItem.Owner or the owner is not a RenderObjectCollection. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the ParagraphObjectCollection representing the content (text and images) of the current paragraph. (Inherited from C1.C1Preview.RenderParagraph)
    Public PropertyGets the collection of RenderObject objects generated by data binding. The value of this property is null if the object is not data bound. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets an instance of C1.C1Preview.DataBinding.C1DataBinding class representing the data binding properties of the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets a value indicating whether the current object is data bound. Returns true if the object's RenderObject.DataBinding property has been initialized and its C1.C1Preview.DataBinding.C1DataBinding.Mode is not DataBindingModeEnum.None. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets a combination of DataBindingModeEnum flags specifying the data binding mode of the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the C1PrintDocument object containing the current RenderObject. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyTBD: 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. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the first fragment of the current object, or null if RenderObject.Fragments has not been initialized yet. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets a script that is executed each time a new instance of the current RenderObject is created due to data binding resolving. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the script that is executed each time a RenderFragment of the current render object is created and added to the RenderObject.Fragments collection on the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets a RenderFragmentCollection containing the fragments produced by the current object in the generated document. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets a value indicating whether the current object has any anchors associated with it (i.e. whether the RenderObject.Anchors collection exists and is not empty). (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets a value indicating whether the current object has children (i.e. its RenderObject.Children collection contains at least one element). (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets a value indicating whether the RenderParagraph.Content collection has been initialized and contains one or more elements. (Inherited from C1.C1Preview.RenderParagraph)
    Public PropertyGets a value indicating whether the current object's RenderObject.Fragments collection has been initialized and contains one or more fragments. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets a value indicating whether the RenderTextBase.TabPositions collection has been initialized and contains one or more elements. (Inherited from C1.C1Preview.RenderTextBase)
    Public PropertyOverridden. Gets a value indicating whether the current TOC entry will produce visible output in the generated document.  
    Public PropertyGets 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 C1PrintDocument.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").

    (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the hyperlink (see C1Hyperlink) associated with the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the index of the current object within the IOwnedCollectionItem.Owner, or -1 if there is no owner. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets a render object which should be printed on the same page as the current object. The specified object must have the same RenderObject.Parent as the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the last fragment of the current object, or null if RenderObject.Fragments has not been initialized yet. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the LayoutChangeBase object defining the change of page layout that will occur after the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the LayoutChangeBase object defining the change of page layout that will occur before the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the level of the current entry in the TOC. This value is 1-based, and determines the indentation of the current item in the generated TOC. The default value is 1, which does not indent the entry. Nested levels are indented by the RenderToc.LevelSpacing amount.  
    Public PropertyGets 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). (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the script that is executed when the current object has been completely resolved, all its fragments created and added to the RenderObject.Fragments collection of the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the script that is executed before resolving the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the original RenderObject object that produced the current object during data binding, or null if there is no such object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the RenderObject.PageNumberingChange object defining the page numbering change that will occur when the current object is rendered. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the parent RenderObject containing the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the RenderTocItem.RenderToc object containing the current TOC entry.  
    Public PropertyGets 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. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets 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. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the stacking rules used to arrange the children of the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the RenderObject.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. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the most nested RenderTable containing the current render object, or null if the current object is not contained in a table. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the RenderObject.TableCell object containing the current object, or null if the current object is not contained in a cell of a RenderTable. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets 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. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets 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. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets the collection of TabPosition objects representing tab stops associated with the current text. (Inherited from C1.C1Preview.RenderTextBase)
    Public PropertyGets or sets the text of the current paragraph. (Inherited from C1.C1Preview.RenderParagraph)
    Public PropertyOverridden. Gets the count of characters in the current TOC entry.  
    Public PropertyGets or sets arbitrary data associated with the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets a value indicating the visibility of the current object. (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets 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 C1PrintDocument.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)").

    (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the X coordinate of the current object.

    May be specified as auto (Unit.Auto), an absolute value (using C1PrintDocument.DefaultUnit), an absolute value with unit of measurement (e.g. "12mm"), or an expression referencing this and other objects (e.g. "prev.right+2mm").

    (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets or sets the Y coordinate of the current object.

    May be specified as auto (Unit.Auto), an absolute value (using C1PrintDocument.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").

    (Inherited from C1.C1Preview.RenderObject)
    Public PropertyGets 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. (Inherited from C1.C1Preview.RenderObject)
    Top
    Protected Properties
     NameDescription
    Protected PropertyGets the hashtable containing the calculated values. (Inherited from C1.C1Preview.RenderObject)
    Protected PropertyGets a value indicating whether the RenderObject.CalculatedValues hashtable exists and is not empty. (Inherited from C1.C1Preview.RenderObject)
    Protected PropertyFor internal use. (Inherited from C1.C1Preview.RenderObject)
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Assigns (copies) properties from another RenderObject to the current object. Calls the base RenderTextBase.AssignFrom method. If source is a RenderParagraph, also copies RenderParagraph-specific properties. (Inherited from C1.C1Preview.RenderParagraph)
    Public MethodCalculates the size of the current object. When this method is called, the object must already have been added to the document (e.g. to C1PrintDocument.Body or to RenderObject.Children of another object in the document). See remarks for more details. (Inherited from C1.C1Preview.RenderObject)
    Public MethodOverloaded. Clones the current RenderObject. (Inherited from C1.C1Preview.RenderObject)
    Public MethodCalculates the count of objects which are nested within this object. This method takes into account child objects and their children. (Inherited from C1.C1Preview.RenderObject)
    Public MethodCalculates the number of objects which are owned by the current object. (Inherited from C1.C1Preview.RenderObject)
    Public MethodReturns the index of the specified RenderFragment of the current object in the RenderObject.Fragments collection. (Inherited from C1.C1Preview.RenderObject)
    Top
    Protected Methods
     NameDescription
    Protected MethodFor internal use. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodCreates new empty RenderParagraph object linked with same C1PrintDocument as current object. (Inherited from C1.C1Preview.RenderParagraph)
    Protected MethodGets the value of a child's ambient style property. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodOverride this method and return false if you want manually copy of children objects for this object. This method returns true by default. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodReturns the C1.C1Preview.DataBinding.C1DataBinding object for a specified child object. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodGets the default value for the RenderObject.Clip property. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodGets the default value for the RenderObject.Height property. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodGets the default value for the RenderObject.SplitHorzBehavior property. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodReturns a human-readable textual description of the location of the current object in the document. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodReturns 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); } } (Inherited from C1.C1Preview.RenderObject)
    Protected MethodOverride this method to perform additional actions when value of the Height property of object is being read. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodGets the value of a child's non-ambient style property. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodIndicates 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. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodOverride this method to perform additional actions when value of the Width property of object is being read. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodPerforms some initializations. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodThis method is called once for each object, override it to perform custom initialization. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodInternal use only. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodSets value of flag. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodOverride this method to perform additional actions when value of the Height property of object is being defined. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodOverride this method to perform additional actions when value of the SplitHorzBehavior property of object is being defined. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodOverride this method to perform additional actions when value of the SplitVertBehavior property of object is being defined. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodOverride this method to perform additional actions when value of the Width property of object is being defined. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodTests whether the RenderObject.Children property should be serialized. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodTests whether the RenderObject.Clip property should be serialized. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodTests whether the Flags property should be serialized. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodTests whether the RenderObject.Height property should be serialized. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodTests whether the RenderObject.Name property should be serialized. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodTests whether the RenderObject.SplitHorzBehavior property should be serialized. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodTests whether the RenderObject.SplitVertBehavior property should be serialized. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodTests whether the RenderObject.Style property should be serialized. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodIndicates whether the RenderTextBase.TabPositions property should be serialized. (Inherited from C1.C1Preview.RenderTextBase)
    Protected MethodTests whether the RenderObject.Width property should be serialized. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodTests whether the RenderObject.X property should be serialized. (Inherited from C1.C1Preview.RenderObject)
    Protected MethodTests whether the RenderObject.Y property should be serialized. (Inherited from C1.C1Preview.RenderObject)
    Top
    See Also