Class WorksheetConditionalFormats
Summary description for WorksheetConditionalFormats.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Collections
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class WorksheetConditionalFormats : CollectionBaseEx<ConditionalFormats>, IList<ConditionalFormats>, ICollection<ConditionalFormats>, IEnumerable<ConditionalFormats>, IEnumerable, IParentApplication, ICloneParentConstructors
WorksheetConditionalFormats(IApplication, Object)
Initializes new instance of the collection.
Declaration
public WorksheetConditionalFormats(IApplication application, object parent)Parameters
| Type | Name | Description |
|---|---|---|
| IApplication | application | Application object for the new collection. |
| System.Object | parent | Parent object for the new collection. |
Methods
Add(ConditionalFormats)
Adds new item to the collection.
Declaration
public ConditionalFormats Add(ConditionalFormats formats)Parameters
| Type | Name | Description |
|---|---|---|
| ConditionalFormats | formats | Item to add. |
Returns
| Type | Description |
|---|---|
| ConditionalFormats | Object that contains required cells. |
Clone(Object)
Creates a new object that is a copy of the current instance.
Declaration
public override object Clone(object parent)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | parent | Parent object for a copy of this instance. |
Returns
| Type | Description |
|---|---|
| System.Object | A new object that is a copy of this instance. |
Overrides
Contains(ConditionalFormats)
Defines whether collection contains conditional format.
Declaration
public ConditionalFormats Contains(ConditionalFormats formats)Parameters
| Type | Name | Description |
|---|---|---|
| ConditionalFormats | formats | Conditional formats. |
Returns
| Type | Description |
|---|---|
| ConditionalFormats | Conditional formats if exists or null. |
CopyFrom(WorksheetConditionalFormats)
Copies conditional formats from another formats collection.
Declaration
public void CopyFrom(WorksheetConditionalFormats arrSourceFormats)Parameters
| Type | Name | Description |
|---|---|---|
| WorksheetConditionalFormats | arrSourceFormats | Source collection of conditional formats to copy. |
Dispose()
Disposes conditional formats
Declaration
public void Dispose()Find(Rectangle[])
Search for collection that contains all specified ranges.
Declaration
public ConditionalFormats Find(Rectangle[] arrRanges)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Rectangle[] | arrRanges |
Returns
| Type |
|---|
| ConditionalFormats |
MarkUsedReferences(Boolean[])
Sets items with used reference indexes to true.
Declaration
public void MarkUsedReferences(bool[] usedItems)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean[] | usedItems | Array to mark used references in. |
Remove(Rectangle[])
Removes range from the collection of conditional formats.
Declaration
public void Remove(Rectangle[] arrRanges)Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Rectangle[] | arrRanges | Array of ranges to remove. |
RemoveItem(ConditionalFormats)
Declaration
public void RemoveItem(ConditionalFormats formats)Parameters
| Type | Name | Description |
|---|---|---|
| ConditionalFormats | formats |
Serialize(OffsetArrayList)
Serializes all conditional formats as Biff records.
Declaration
public void Serialize(OffsetArrayList records)Parameters
| Type | Name | Description |
|---|---|---|
| OffsetArrayList | records | OffsetArrayList to serialize records into. |
UpdateFormula(Int32, Int32, Rectangle, Int32, Rectangle)
Updates conditional format formulas.
Declaration
public void UpdateFormula(int iCurIndex, int iSourceIndex, Rectangle sourceRect, int iDestIndex, Rectangle destRect)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iCurIndex | Current worksheet index. |
| System.Int32 | iSourceIndex | Source worksheet index. |
| System.Drawing.Rectangle | sourceRect | Source rectangle. |
| System.Int32 | iDestIndex | Destination worksheet index. |
| System.Drawing.Rectangle | destRect | Destination rectangle. |
UpdateReferenceIndexes(Int32[])
Updates reference indexes.
Declaration
public void UpdateReferenceIndexes(int[] arrUpdatedIndexes)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32[] | arrUpdatedIndexes | Array with updated indexes. |