Class MarkerArgument
Class used for Marker Argument.
Inheritance
Implements
Namespace: Syncfusion.XlsIO.Implementation.TemplateMarkers
Assembly: Syncfusion.XlsIO.UWP.dll
Syntax
public abstract class MarkerArgument : Object, ICloneableConstructors
MarkerArgument()
Initializes a new instance of the MarkerArgument class.
Declaration
public MarkerArgument()Fields
DEF_PARTS_SEPARATOR
Argument parts separator.
Declaration
protected const char DEF_PARTS_SEPARATOR = ':'Field Value
| Type |
|---|
| System.Char |
Properties
ArgumentChecker
Gets regular expression used to check argument. Read-only.
Declaration
protected virtual Regex ArgumentChecker { get; }Property Value
| Type |
|---|
| System.Text.RegularExpressions.Regex |
IsAllowMultiple
Indicates whether argument can be present multiple times in single template marker. Read-only.
Declaration
public virtual bool IsAllowMultiple { get; }Property Value
| Type |
|---|
| System.Boolean |
IsApplyable
Indicates whether marker should be applies for each marker value. Read-only.
Declaration
public virtual bool IsApplyable { get; }Property Value
| Type |
|---|
| System.Boolean |
IsPreparing
Indicates whether argument is used just to prepare some options before any values are proceed. Read-only.
Declaration
public virtual bool IsPreparing { get; }Property Value
| Type |
|---|
| System.Boolean |
Priority
Gets priority of the argument. Read-only.
Declaration
public virtual int Priority { get; }Property Value
| Type |
|---|
| System.Int32 |
Methods
ApplyArgument(IWorksheet, Point, ref Int32, ref Int32, IList<Int64>, MarkerOptionsImpl, Int32)
Applies argument to the marker at the specified position and to the list of cells with markers.
Declaration
public virtual void ApplyArgument(IWorksheet sheet, Point pOldPosition, ref int iRow, ref int iColumn, IList<long> arrMarkerCells, MarkerOptionsImpl options, int count)Parameters
| Type | Name | Description |
|---|---|---|
| IWorksheet | sheet | Worksheet that contains cell to apply marker argument to. |
| Point | pOldPosition | Previous cell position. |
| System.Int32 | iRow | One-based row index of the cell to apply marker argument to. |
| System.Int32 | iColumn | One-based column index of the cell to apply marker argument to. |
| System.Collections.Generic.IList<System.Int64> | arrMarkerCells | List of cells with markers. |
| MarkerOptionsImpl | options | Marker options. |
| System.Int32 | count |
Clone()
Creates a new object that is a copy of the current instance.
Declaration
public virtual object Clone()Returns
| Type | Description |
|---|---|
| System.Object | Copy of the current instance. |
InsertColumn(IList<Int64>, Int32, Int32, Int32)
Inserts column int list of cell indexes.
Declaration
protected static void InsertColumn(IList<long> arrCells, int i, int iColumnIndex, int count)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IList<System.Int64> | arrCells | List with cell indexes. |
| System.Int32 | i | Starting index. |
| System.Int32 | iColumnIndex | One-based column index. |
| System.Int32 | count |
InsertRow(IList<Int64>, Int32, Int32, Int32)
Inserts row int list of cell indexes.
Declaration
protected static void InsertRow(IList<long> arrCells, int i, int iRowIndex, int count)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IList<System.Int64> | arrCells | List with cell indexes. |
| System.Int32 | i | Starting index. |
| System.Int32 | iRowIndex | Row index. |
| System.Int32 | count |
Parse(Match)
Parses regular expression match.
Declaration
protected virtual MarkerArgument Parse(Match m)Parameters
| Type | Name | Description |
|---|---|---|
| System.Text.RegularExpressions.Match | m | Match to parse. |
Returns
| Type | Description |
|---|---|
| MarkerArgument | Parsed argument of the same type as this instance is. |
PrepareOptions(MarkerOptionsImpl)
Prepares options if necessary.
Declaration
public virtual void PrepareOptions(MarkerOptionsImpl options)Parameters
| Type | Name | Description |
|---|---|---|
| MarkerOptionsImpl | options | Options to prepare. |
TryParse(String)
Tries to parse argument string.
Declaration
public virtual MarkerArgument TryParse(string strArgument)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | strArgument | Argument to parse. |
Returns
| Type | Description |
|---|---|
| MarkerArgument | Parsed argument if possible; null otherwise. |