Class History

Class that represents the history of loaded HTML documents for the control.

Inheritance

System.Object

History

Implements

System.IDisposable

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.Windows.Forms.HTMLUI

Assembly: Syncfusion.HTMLUI.Windows.dll

Syntax

public class History : IDisposable

Constructors

History()

Initializes a new instance of the History class

Declaration

public History()

Properties

Count

Gets the number of items in the history.

Declaration

public int Count { get; }

Property Value

Type
System.Int32

CurrentIndex

Gets the current index in the history.

Declaration

public int CurrentIndex { get; }

Property Value

Type
System.Int32

Item[Int32]

Gets the type of path for the document with the specified index.

Declaration

protected PathType this[int index] { get; }

Parameters

Type	Name	Description
System.Int32	index	Integer index value

Property Value

Type
PathType

Methods

Contains(String)

Indicates whether the specified path already exists in the history.

Declaration

protected bool Contains(string path)

Parameters

Type	Name	Description
System.String	path	Path for searching.

Returns

Type	Description
System.Boolean	True if history already contains such path; false otherwise.

Dispose()

Disposes object.

Declaration

public void Dispose()

ExcludeFromVisited(AElementImpl)

Excludes the link element from the list of visited links.

Declaration

public void ExcludeFromVisited(AElementImpl linkElement)

Parameters

Type	Name	Description
AElementImpl	linkElement	Element for excluding from visited list.

GetAt(Int32)

Returns the path from history stack container according to the defined deep value. If step is greater than stack capacity, it returns an empty string.

Declaration

public HistoryPair GetAt(int deep)

Parameters

Type	Name	Description
System.Int32	deep	Index in history for getting path.

Returns

Type	Description
HistoryPair	History item.

Remarks

Deep value must be less than or equal to zero. This method does not remove any elements from the history stack.

Pop(Int32)

Returns the path from history stack container according to the defined deep value. If step is greater than stack capacity, it returns an empty string.

Declaration

public HistoryPair Pop(int deep)

Parameters

Type	Name	Description
System.Int32	deep	Index in history for getting the path.

Returns

Type	Description
HistoryPair	History item.

Remarks

Deep value must be less than or equal to zero.

Push(String, PathType)

Pushes the path to the document in the history.

Declaration

public int Push(string path, PathType type)

Parameters

Type	Name	Description
System.String	path	String path for history inserting.
PathType	type	Type of path.

Returns

Type	Description
System.Int32	Integer value

ResetVisited()

Resets the list of visited links.

Declaration

public void ResetVisited()

Implements

System.IDisposable