SpreadJS 13
GC.Spread.Sheets Namespace / Workbook type / getNamedStyle Method
The name of the style to return.
In This Topic
    getNamedStyle Method
    In This Topic
    Gets a style from the Workbook named styles collection which has the specified name.
    Syntax
    var instance = new GC.Spread.Sheets.Workbook(host,
                                                options,
                                                options.sheetCount,
                                                options.font,
                                                options.allowUserDragMerge,
                                                options.allowUserDragDrop,
                                                options.allowUserDragFill,
                                                options.allowUserZoom,
                                                options.allowUserResize,
                                                options.allowUndo,
                                                options.allowSheetReorder,
                                                options.allowContextMenu,
                                                options.allowUserDeselect,
                                                options.defaultDragFillType,
                                                options.showDragFillSmartTag,
                                                options.showHorizontalScrollbar,
                                                options.showVerticalScrollbar,
                                                options.scrollbarShowMax,
                                                options.scrollbarMaxAlign,
                                                options.tabStripVisible,
                                                options.tabStripRatio,
                                                options.tabEditable,
                                                options.newTabVisible,
                                                options.tabNavigationVisible,
                                                options.cutCopyIndicatorVisible,
                                                options.cutCopyIndicatorBorderColor,
                                                options.backColor,
                                                options.backgroundImage,
                                                options.backgroundImageLayout,
                                                options.grayAreaBackColor,
                                                options.showResizeTip,
                                                options.showDragDropTip,
                                                options.showDragFillTip,
                                                options.showScrollTip,
                                                options.scrollIgnoreHidden,
                                                options.highlightInvalidData,
                                                options.useTouchLayout,
                                                options.hideSelection,
                                                options.resizeZeroIndicator,
                                                options.allowUserEditFormula,
                                                options.enableFormulaTextbox,
                                                options.autoFitType,
                                                options.referenceStyle,
                                                options.calcOnDemand,
                                                options.allowCopyPasteExcelStyle,
                                                options.allowExtendPasteRange,
                                                options.copyPasteHeaderOptions,
                                                options.scrollByPixel,
                                                options.scrollPixel,
                                                options.allowAutoCreateHyperlink,
                                                options.columnResizeMode,
                                                options.rowResizeMode,
                                                options.customList,
                                                options.scrollbarAppearance);
    var value; // Type: Style
    value = instance.getNamedStyle(name);
    function getNamedStyle( 
       name : string
    ) : Style;

    Parameters

    name
    The name of the style to return.

    Return Value

    Returns the specified named style.
    Example
    This example gets a named style.
    <input type="button" id="button1" value="button1"/>
    
    var namedStyle = new GC.Spread.Sheets.Style();
    namedStyle.name = "style1";
    namedStyle.backColor = "green";
    spread.addNamedStyle(namedStyle);
    activeSheet.setStyleName(1, 1, "style1"); // cell(1,1)'s backColor is  green.
    activeSheet.setStyleName(2, 1, "style1");
     
    var style = spread.getNamedStyle("style1");
    style.foreColor = "red";    // the namedStyle's foreColor is red.
    activeSheet.repaint(); // the foreColor of the cell(1,1) and cell(2,1) is red.
    activeSheet.getCell(1,1).value("test");
    
    $("#button1").click(function () {
    spread.removeNamedStyle("style1");
        });
    See Also

    Reference

    Workbook type