TSheetSelector Class
Abstract class to implement a Sheet Selector. Derive from this class for example to implement tabs with images. For a standard implementation using CSS Tabs and divs, use TStandardSheetSelector
Syntax
Namespace: FlexCel.Render
public abstract class TSheetSelector
Constructors
Name | Description |
---|---|
TSheetSelector | Constructs a new TSheetSelector instance. |
Methods
Name | Description |
---|---|
GetHtmlSheetNameFromExcel | Returns the html sheet name from the Excel sheet name. Returns empty if the sheet doesn't exist. |
WriteLn | Use this method to write a line inside the stream when overriding this class. |
EncodeAsHtml | This method will encode an string so it is valid html. For example, it will replace "&" by "&" in the text. |
AfterDrawOneSheetSelector | Use this method to customize actions to do before the SheetSelector is drawn. In the TStandardSheetSelector implementation, this method is used to add a table for layout if TStandardSheetSelector.LayoutTable is true. Note that this method is called once for each of the possible positions of Reference, even if you do not need to draw a selector in that position. The order in which this method will be called is: Top, Left, Right, Bottom. |
BeforeDrawOneSheetSelector | Use this method to customize actions to do after the SheetSelector is drawn. In the TStandardSheetSelector implementation, this method is used to add a table for layout if TStandardSheetSelector.LayoutTable is true. Note that this method is called once for each of the possible positions of Reference, even if you do not need to draw a selector in that position. The order in which this method will be called is: Top, Left, Right, Bottom. |
DrawOneSheetSelector | Override this method on a child class if you want to completely customize how the Sheet Selector is drawn. Normally when deriving from TStandardSheetSelector you can just change the CSS properties of this class to customize the SheetSelector, but you can use this if you want to provide a completely different selector. You can use the Links collection to know which hyperlinks to place in each place. Note that different from BeforeDrawOneSheetSelector...[more] |
WriteCssClasses | This method is in charge of writing the style definitions in the header of the html file. Note that when deriving from TStandardSheetSelector you normally do not need to override this method, you can just change the CSS properties of this class. You can override this method if you want full control on how to export the classes. |
Properties
Name | Description |
---|---|
SheetSelectorPosition | An enumerator defining all the positions where the SheetSelector will be drawn.Read it to know where to draw the selector. |
Links | A list of links that should go in the sheet selector, one per tab. Use them when creating your own sheet selector to know where to point the link in the tabs to. |