Class StyleGroup
Summary description for StyleGroup.
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Collections.Grouping
Assembly: Syncfusion.XlsIO.NET.dll
Syntax
public class StyleGroup : CommonObject, IDisposable, IStyle, IExtendedFormat, IParentApplication, IOptimizedUpdate, IXFIndex
Constructors
StyleGroup(IApplication, Object)
Creates new instance of the group.
Declaration
public StyleGroup(IApplication application, object parent)
Parameters
| Type | Name | Description |
|---|---|---|
| IApplication | application | Application object for the new group. |
| System.Object | parent | Parent object for the new group. |
Properties
Borders
Returns a Borders collection that represents the borders of a style or a range of cells (including a range defined as part of a conditional format).
Declaration
public IBorders Borders { get; }
Property Value
| Type |
|---|
| IBorders |
BuiltIn
True if the style is a built-in style. Read-only Boolean.
Declaration
public bool BuiltIn { get; }
Property Value
| Type |
|---|
| System.Boolean |
Color
Returns or sets the cell shading color.
Declaration
public Color Color { get; set; }
Property Value
| Type |
|---|
| Color |
ColorIndex
Gets / sets index of fill foreground color.
Declaration
public ExcelKnownColors ColorIndex { get; set; }
Property Value
| Type |
|---|
| ExcelKnownColors |
Count
Returns number of elements in the group. Read-only.
Declaration
public int Count { get; }
Property Value
| Type |
|---|
| System.Int32 |
FillBackground
Gets / sets index of fill background color.
Declaration
public ExcelKnownColors FillBackground { get; set; }
Property Value
| Type |
|---|
| ExcelKnownColors |
FillBackgroundRGB
Gets / Sets fill background color.
Declaration
public Color FillBackgroundRGB { get; set; }
Property Value
| Type |
|---|
| Color |
FillForeground
Gets / sets index of fill foreground color.
Declaration
public ExcelKnownColors FillForeground { get; set; }
Property Value
| Type |
|---|
| ExcelKnownColors |
FillForegroundRGB
Gets / sets fill foreground color.
Declaration
public Color FillForegroundRGB { get; set; }
Property Value
| Type |
|---|
| Color |
FillPattern
Gets / sets fill pattern.
Declaration
public ExcelPattern FillPattern { get; set; }
Property Value
| Type |
|---|
| ExcelPattern |
Font
Returns a Font object that represents the font of the specified object.
Declaration
public IFont Font { get; }
Property Value
| Type |
|---|
| IFont |
FormulaHidden
True if the formula will be hidden when the worksheet is protected. Read/write Boolean.
Declaration
public bool FormulaHidden { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
HasBorder
Gets whether borser is present.
Declaration
public bool HasBorder { get; }
Property Value
| Type |
|---|
| System.Boolean |
HorizontalAlignment
Returns or sets the horizontal alignment for the specified object. For all objects, this can be one of the following ExcelHAlign constants. Read/write ExcelHAlign.
Declaration
public ExcelHAlign HorizontalAlignment { get; set; }
Property Value
| Type |
|---|
| ExcelHAlign |
IncludeAlignment
True if the style includes the AddIndent, HorizontalAlignment, VerticalAlignment, WrapText, and Orientation properties. Read/write Boolean.
Declaration
public bool IncludeAlignment { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IncludeBorder
True if the style includes the Color, ColorIndex, LineStyle, and Weight border properties. Read/write Boolean.
Declaration
public bool IncludeBorder { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IncludeFont
True if the style includes the Background, Bold, Color, ColorIndex, FontStyle, Italic, Name, OutlineFont, Shadow, Size, Strikethrough, Subscript, Superscript, and Underline font properties. Read/write Boolean.
Declaration
public bool IncludeFont { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IncludeNumberFormat
True if the style includes the NumberFormat property. Read/write Boolean.
Declaration
public bool IncludeNumberFormat { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IncludePatterns
True if the style includes the Color, ColorIndex, InvertIfNegative, Pattern, PatternColor, and PatternColorIndex interior properties. Read / write Boolean.
Declaration
public bool IncludePatterns { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IncludeProtection
True if the style includes the FormulaHidden and Locked protection properties. Read/write Boolean.
Declaration
public bool IncludeProtection { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IndentLevel
Returns or sets the indent level for the style. Read/write.
Declaration
public int IndentLevel { get; set; }
Property Value
| Type |
|---|
| System.Int32 |
Interior
Returns Interior object that represents interior of the specified object.
Declaration
public IInterior Interior { get; }
Property Value
| Type |
|---|
| IInterior |
IsFirstSymbolApostrophe
If true then first symbol in cell is apostrophe.
Declaration
public bool IsFirstSymbolApostrophe { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IsInitialized
Indicates whether style is initialized (differs from Normal style). Read-only.
Declaration
public bool IsInitialized { get; }
Property Value
| Type |
|---|
| System.Boolean |
IsModified
Gets value indicating whether format was modified, compared to parent format.
Declaration
public bool IsModified { get; }
Property Value
| Type |
|---|
| System.Boolean |
Item[Int32]
Returns single entry from the group. Read-only.
Declaration
public IStyle this[int index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index |
Property Value
| Type |
|---|
| IStyle |
JustifyLast
For far east languages. Supported only for format. Always False for US.
Declaration
public bool JustifyLast { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Locked
True if the object is locked, False if the object can be modified when the sheet is protected. Read/write Boolean.
Declaration
public bool Locked { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Name
Returns or sets the name of the object. Read-only String.
Declaration
public string Name { get; }
Property Value
| Type |
|---|
| System.String |
NumberFormat
Returns or sets the format code for the object. Read/write String.
Declaration
public string NumberFormat { get; set; }
Property Value
| Type |
|---|
| System.String |
NumberFormatIndex
Gets / sets index of the number format.
Declaration
public int NumberFormatIndex { get; set; }
Property Value
| Type |
|---|
| System.Int32 |
NumberFormatLocal
Returns or sets the format code for the object. Read/write String.
Declaration
public string NumberFormatLocal { get; set; }
Property Value
| Type |
|---|
| System.String |
NumberFormatSettings
Returns object that describes number format. Read-only.
Declaration
public INumberFormat NumberFormatSettings { get; }
Property Value
| Type |
|---|
| INumberFormat |
PatternColor
Gets / Sets fill background color.
Declaration
public Color PatternColor { get; set; }
Property Value
| Type |
|---|
| Color |
PatternColorIndex
Gets / sets index of fill background color.
Declaration
public ExcelKnownColors PatternColorIndex { get; set; }
Property Value
| Type |
|---|
| ExcelKnownColors |
ReadingOrder
Text direction, the reading order for far east versions.
Declaration
public ExcelReadingOrderType ReadingOrder { get; set; }
Property Value
| Type |
|---|
| ExcelReadingOrderType |
Rotation
Text rotation angle: 0 Not rotated 1-90 1 to 90 degrees counterclockwise 91-180 1 to 90 degrees clockwise 255 Letters are stacked top-to-bottom, but not rotated.
Declaration
public int Rotation { get; set; }
Property Value
| Type |
|---|
| System.Int32 |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | Thrown when value is more than 0xFF. |
ShrinkToFit
True if text automatically shrinks to fit in the available column width. Read/write Boolean.
Declaration
public bool ShrinkToFit { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
VerticalAlignment
Returns or sets the vertical alignment of the specified object. Read/write ExcelVAlign.
Declaration
public ExcelVAlign VerticalAlignment { get; set; }
Property Value
| Type |
|---|
| ExcelVAlign |
Workbook
Returns parent workbook object. Read-only.
Declaration
public WorkbookImpl Workbook { get; }
Property Value
| Type |
|---|
| WorkbookImpl |
WrapText
True if Excel wraps the text in the object. Read/write Boolean.
Declaration
public bool WrapText { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
XFormatIndex
Gets format index in m_book.InnerFormats.
Declaration
public int XFormatIndex { get; }
Property Value
| Type |
|---|
| System.Int32 |
Methods
BeginUpdate()
This method should be called before several updates to the object will take place.
Declaration
public virtual void BeginUpdate()
EndUpdate()
This method should be called after several updates to the object.
Declaration
public virtual void EndUpdate()