Class StyleArrayWrapper
Style wrapper for multicell range. Redirects all properties and method calls to the range styles.
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public class StyleArrayWrapper : CommonObject, IDisposable, IStyle, IExtendedFormat, IParentApplication, IOptimizedUpdate, IXFIndex
Constructors
StyleArrayWrapper(IApplication, List<IRange>, IWorksheet)
Creates object that will contain all styles that are used by range.
Declaration
public StyleArrayWrapper(IApplication application, List<IRange> LstRange, IWorksheet worksheet)
Parameters
Type | Name | Description |
---|---|---|
IApplication | application | |
System.Collections.Generic.List<IRange> | LstRange | |
IWorksheet | worksheet |
StyleArrayWrapper(IRange)
Creates object that will contain all styles that are used by range.
Declaration
public StyleArrayWrapper(IRange range)
Parameters
Type | Name | Description |
---|---|---|
IRange | range | Range from which styles must be taken. |
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 |
---|
Windows.UI.Color |
ColorIndex
Returns or sets the color of the interior. The color is specified as an index value into the current color palette.
Declaration
public ExcelKnownColors ColorIndex { get; set; }
Property Value
Type |
---|
ExcelKnownColors |
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 |
---|
Windows.UI.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 |
---|
Windows.UI.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. Read-only.
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
Indicates whether style has border. Read-only Boolean.
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 the interior of the specified object. Read-only.
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 |
JustifyLast
For far east languages. Supported only for format. Always 0 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 as a string in the language of the user. 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
Returns or sets the color of the interior pattern as an Color value.
Declaration
public Color PatternColor { get; set; }
Property Value
Type |
---|
Windows.UI.Color |
PatternColorIndex
Returns or sets the color of the interior pattern as an index into the current color palette.
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. int.MinValue - different rotation angle for different ranges.
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 |
WrapText
True if Microsoft 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()