Removes specified type of marking information at specified range.

Namespace: Sgry.Azuki
Assembly: Azuki (in Azuki.dll) Version: 1.7.13.40248

Syntax

C#
public bool Unmark(
	int begin,
	int end,
	int markingID
)
Visual Basic
Public Function Unmark ( 
	begin As Integer,
	end As Integer,
	markingID As Integer
) As Boolean

Parameters

begin
Type: System..::..Int32
The index of where the range begins.
end
Type: System..::..Int32
The index of where the range ends.
markingID
Type: System..::..Int32
The ID of the marking to be removed.

Return Value

Type: Boolean
Whether any marking data was removed or not.

Remarks

This method scans range of [begin, end) and removes specified marking ID.

For detail of marking feature, please refer to the document of Marking class.

Exceptions

ExceptionCondition
System..::..ArgumentOutOfRangeException Parameter begin or end is out of valid range. - OR - Parameter markingID is out of valid range.
System..::..ArgumentException Parameter begin is equal or greater than end. - OR - Parameter markingID is not registered to Marking class.

See Also