IdReserver Class

This class is responsible for shape id's reservation.

Inheritance

System.Object

IdReserver

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.XlsIO.Implementation

Assembly: Syncfusion.XlsIO.Base.dll

Syntax

public class IdReserver

Constructors

IdReserver()

Declaration

public IdReserver()

Fields

SegmentSize

Size of the single id's segment.

Declaration

public const int SegmentSize = 1024

Field Value

Type
System.Int32

Properties

MaximumId

Gets maximum accessed shape id.

Declaration

public int MaximumId { get; }

Property Value

Type
System.Int32

Methods

AddAdditionalShapes(Int32, Int32)

Registers any number of additional shapes required by collection.

Declaration

public void AddAdditionalShapes(int collectionIndex, int shapesNumber)

Parameters

Type	Name	Description
System.Int32	collectionIndex	Collection index.
System.Int32	shapesNumber	Number of additional shapes to add.

CheckFree(Int32, Int32)

Checks whether segment with specified id is free.

Declaration

public bool CheckFree(int id, int count)

Parameters

Type	Name	Description
System.Int32	id	Id to check.
System.Int32	count	Number of segments to check.

Returns

Type	Description
System.Boolean	True if all segments are free.

CheckReserved(Int32)

Checks whether segment with specified it is already reserved.

Declaration

public bool CheckReserved(int id)

Parameters

Type	Name	Description
System.Int32	id	Id to check.

Returns

Type
System.Boolean

FreeSegmentsSequence(Int32, Int32)

Frees segments sequence if they belong to specified collection.

Declaration

public void FreeSegmentsSequence(int id, int collectionId)

Parameters

Type	Name	Description
System.Int32	id	Id to detect first segment.
System.Int32	collectionId	Collection to free segments for.

FreeSequence(Int32)

Frees all segments allocated by the collection.

Declaration

public void FreeSequence(int collectionId)

Parameters

Type	Name	Description
System.Int32	collectionId	Collection id.

GetAdditionalShapesNumber(Int32)

Gets number of additional shapes reserved by collection.

Declaration

public int GetAdditionalShapesNumber(int collectionIndex)

Parameters

Type	Name	Description
System.Int32	collectionIndex	Collection index.

Returns

Type	Description
System.Int32	Number of additional shapes.

GetReservedCount(Int32)

Returns number of reserved ids by specified collection.

Declaration

public int GetReservedCount(int collectionId)

Parameters

Type	Name	Description
System.Int32	collectionId	Collection index.

Returns

Type	Description
System.Int32	Number of reserved ids.

GetSegmentStart(Int32)

Evaluates start of the segment containing specified id.

Declaration

public static int GetSegmentStart(int id)

Parameters

Type	Name	Description
System.Int32	id	Id to get segment start for.

Returns

Type
System.Int32

ReservedBy(Int32)

Gets index of the collection which reserved specified id.

Declaration

public int ReservedBy(int id)

Parameters

Type	Name	Description
System.Int32	id	Id to check.

Returns

Type	Description
System.Int32	Index of the collection which reserved id, or 0 if it is not reserved.

ReservedCount(Int32)

Gets number of reserved shapes inside specified sector.

Declaration

public int ReservedCount(int id)

Parameters

Type	Name	Description
System.Int32	id	Id that belongs to the segment that is being investigated.

Returns

Type	Description
System.Int32	Number of reserved ids inside sector.

TryReserve(Int32, Int32, Int32)

Tries to reserve segment or segments containing specified ids for the specified collection.

Declaration

public bool TryReserve(int id, int lastId, int collectionId)

Parameters

Type	Name	Description
System.Int32	id	Start id to reserve.
System.Int32	lastId	Last id to reserve.
System.Int32	collectionId	Collection owning those ids

Returns

Type	Description
System.Boolean	True if reservation succeeded.