Class JumpArgument

JumpArgument for marker. Specifies jump position after applying single template marker element.

Inheritance

System.Object

MarkerArgument

JumpArgument

CopyRangeArgument

Implements

System.ICloneable

Inherited Members

MarkerArgument.ArgumentChecker

MarkerArgument.Clone()

MarkerArgument.DEF_PARTS_SEPARATOR

MarkerArgument.InsertColumn(IList<Int64>, Int32, Int32, Int32)

MarkerArgument.InsertRow(IList<Int64>, Int32, Int32, Int32)

MarkerArgument.IsAllowMultiple

MarkerArgument.IsPreparing

MarkerArgument.Parse(Match)

MarkerArgument.PrepareOptions(MarkerOptionsImpl)

Namespace: Syncfusion.XlsIO.Implementation.TemplateMarkers

Assembly: Syncfusion.XlsIO.NET.dll

Syntax

[TemplateMarker]
public class JumpArgument : MarkerArgument, ICloneable

Constructors

JumpArgument()

Initializes a new instance of the JumpArgument class.

Declaration

public JumpArgument()

JumpArgument(Int32, Int32, Boolean, Boolean)

Initializes a new instance of the JumpArgument class with specified row and column index.

Declaration

public JumpArgument(int iRow, int iColumn, bool bRowRelative, bool bColumnRelative)

Parameters

Type	Name	Description
System.Int32	iRow	Destination row index.
System.Int32	iColumn	Destination column index.
System.Boolean	bRowRelative	Indicates whether row index is relative.
System.Boolean	bColumnRelative	Indicates whether column index is relative.

Fields

DEF_COLUMN_INDEX_GROUP

Name of the group in the regular expression for column index .

Declaration

protected const string DEF_COLUMN_INDEX_GROUP = "ColumnIndex"

Field Value

Type
System.String

DEF_COLUMN_RELATIVE_GROUP

Index of the group in the regular expression to check whether column index is relative.

Declaration

protected const int DEF_COLUMN_RELATIVE_GROUP = 2

Field Value

Type
System.Int32

DEF_COPY_STYLES

Value indicating that styles must be copied after jump operation.

Declaration

protected const string DEF_COPY_STYLES = "copystyles"

Field Value

Type
System.String

DEF_COPY_STYLES_GROUP

Copy styles group name.

Declaration

protected const string DEF_COPY_STYLES_GROUP = "CopyStyles"

Field Value

Type
System.String

DEF_PRIORITY

Argument priority.

Declaration

protected const int DEF_PRIORITY = 2

Field Value

Type
System.Int32

DEF_R1C1_CELL_REGEX

R1C1 cell detection regular expression

Declaration

protected const string DEF_R1C1_CELL_REGEX = "R(\\[)?(?<RowIndex>[\\-]?[\\0-9]{0,5})(?(1)\\])C(\\[)?(?<ColumnIndex>[\\-]?[0-9]{0,3})(?(2)\\])"

Field Value

Type
System.String

DEF_ROW_INDEX_GROUP

Name of the group in the regular expression for row index.

Declaration

protected const string DEF_ROW_INDEX_GROUP = "RowIndex"

Field Value

Type
System.String

DEF_ROW_RELATIVE_GROUP

Index of the group in the regular expression to check whether row index is relative.

Declaration

protected const int DEF_ROW_RELATIVE_GROUP = 1

Field Value

Type
System.Int32

m_bColumnRelative

Determines whether column index is relative or not.

Declaration

protected bool m_bColumnRelative

Field Value

Type
System.Boolean

m_bCopyStyles

Determines whether styles must be copied or not.

Declaration

protected bool m_bCopyStyles

Field Value

Type
System.Boolean

m_bRowRelative

Determines whether row index is relative or not.

Declaration

protected bool m_bRowRelative

Field Value

Type
System.Boolean

m_iColumn

Represents the destination column index.

Declaration

protected int m_iColumn

Field Value

Type
System.Int32

m_iRow

Represents the destination row index.

Declaration

protected int m_iRow

Field Value

Type
System.Int32

Properties

IsApplyable

Indicates whether marker should be applies for each marker value. Read-only.

Declaration

public override bool IsApplyable { get; }

Property Value

Type
System.Boolean

Overrides

MarkerArgument.IsApplyable

Priority

Returns priority of the argument. Read-only.

Declaration

public override int Priority { get; }

Property Value

Type
System.Int32

Overrides

MarkerArgument.Priority

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 override 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

Overrides

MarkerArgument.ApplyArgument(IWorksheet, Point, ref Int32, ref Int32, IList<Int64>, MarkerOptionsImpl, Int32)

GetCellLocation(Point, IWorkbook)

Evaluates new position of the cell with specified original cell position.

Declaration

protected Point GetCellLocation(Point pointStart, IWorkbook book)

Parameters

Type	Name	Description
Point	pointStart	Original cell position.
IWorkbook	book	Workbook where operation is performed.

Returns

Type	Description
Point	Point that contains updated cell position.

GetCellLocation(Point, Int32, Int32, Boolean, Boolean, IWorkbook)

Evaluates new position of the cell.

Declaration

protected static Point GetCellLocation(Point pointStart, int iRow, int iColumn, bool bRowRelative, bool bColumnRelative, IWorkbook book)

Parameters

Type	Name	Description
Point	pointStart	Original cell position.
System.Int32	iRow	Destination row index.
System.Int32	iColumn	Destination column index.
System.Boolean	bRowRelative	Indicates whether row index is relative.
System.Boolean	bColumnRelative	Indicates whether column index is relative.
IWorkbook	book	Workbook where operation is performed.

Returns

Type	Description
Point	Point that contains updated cell position.

TryParse(String)

Tries to parse the specified argument string.

Declaration

public override MarkerArgument TryParse(string strArgument)

Parameters

Type	Name	Description
System.String	strArgument	Argument to parse.

Returns

Type	Description
MarkerArgument	Parsed argument if possible; null otherwise.

Overrides

MarkerArgument.TryParse(String)

TryParseCell(String, out Int32, out Int32, out Boolean, out Boolean)

Converts regular expressions match into row and column coordinates.

Declaration

protected static bool TryParseCell(string strToParse, out int iRow, out int iColumn, out bool bRowRelative, out bool bColumnRelative)

Parameters

Type	Name	Description
System.String	strToParse	Value to parse.
System.Int32	iRow	Resulting row.
System.Int32	iColumn	Resulting column.
System.Boolean	bRowRelative	Indicates whether row index is relative.
System.Boolean	bColumnRelative	Indicates whether column index is relative.

Returns

Type	Description
System.Boolean	True if parsing succeeded.

Implements

System.ICloneable