Class Link
A class that maintains hyperlink information for a clickable object on the graph.
Inherited Members
Namespace: ZedGraph
Assembly: ZedGraph.dll
Syntax
[Serializable]
public class Link : ISerializable, ICloneable
Constructors
| Improve this Doc View SourceLink()
Default constructor. Set all properties to string.Empty, or null.
Declaration
public Link()
Link(SerializationInfo, StreamingContext)
Constructor for deserializing objects
Declaration
protected Link(SerializationInfo info, StreamingContext context)
Parameters
Type | Name | Description |
---|---|---|
SerializationInfo | info | A SerializationInfo instance that defines the serialized data |
StreamingContext | context | A StreamingContext instance that contains the serialized data |
Link(String, String, String)
Construct a Link instance from a specified title, url, and target.
Declaration
public Link(string title, string url, string target)
Parameters
Type | Name | Description |
---|---|---|
String | title | The title for the link (which shows up in the tooltip). |
String | url | The URL destination for the link. |
String | target | The target for the link (typically "_blank" or "_self"). |
Link(Link)
The Copy Constructor
Declaration
public Link(Link rhs)
Parameters
Type | Name | Description |
---|---|---|
Link | rhs | The Link object from which to copy |
Fields
| Improve this Doc View Sourceschema
Current schema value that defines the version of the serialized file
Declaration
public const int schema = 10
Field Value
Type | Description |
---|---|
Int32 |
Remarks
schema started with 10 for ZedGraph version 5
Tag
A tag object for use by the user. This can be used to store additional information associated with the Link. ZedGraph does not use this value for any purpose.
Declaration
public object Tag
Field Value
Type | Description |
---|---|
Object |
Remarks
Note that, if you are going to Serialize ZedGraph data, then any type that you store in Tag must be a serializable type (or it will cause an exception).
Properties
| Improve this Doc View SourceIsActive
Gets a value that indicates if this Link is enabled (see IsEnabled), and that either the Url or the Title is non-null.
Declaration
public bool IsActive { get; }
Property Value
Type | Description |
---|---|
Boolean |
IsEnabled
Gets or sets a property that determines if this link is active. True to have a clickable link, false to ignore the link.
Declaration
public bool IsEnabled { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Target
Gets or sets the target string for this link.
Declaration
public string Target { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
This value should be set to a valid target associated with the "Target" property of an html hyperlink. Typically, this would be "_blank" to open a new browser window, or "_self" to open in the current browser.
Title
Gets or sets the title string for this link.
Declaration
public string Title { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
For web controls, this title will be shown as a tooltip when the mouse hovers over the area of the object that owns this link. Set the value to Empty to have no title.
Url
Gets or sets the url string for this link.
Declaration
public string Url { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Set this value to Empty if you don't want to have a hyperlink associated with the object to which this link belongs.
Methods
| Improve this Doc View SourceClone()
Typesafe, deep-copy clone method.
Declaration
public Link Clone()
Returns
Type | Description |
---|---|
Link | A new, independent copy of this class |
GetObjectData(SerializationInfo, StreamingContext)
Populates a SerializationInfo instance with the data needed to serialize the target object
Declaration
[SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)]
public virtual void GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
Type | Name | Description |
---|---|---|
SerializationInfo | info | A SerializationInfo instance that defines the serialized data |
StreamingContext | context | A StreamingContext instance that contains the serialized data |
MakeCurveItemUrl(GraphPane, CurveItem, Int32)
Create a URL for a CurveItem that includes the index of the point that was selected.
Declaration
public virtual string MakeCurveItemUrl(GraphPane pane, CurveItem curve, int index)
Parameters
Type | Name | Description |
---|---|---|
GraphPane | pane | The GraphPane of interest |
CurveItem | curve | The CurveItem for which to make the url string. |
Int32 | index | The zero-based index of the selected point |
Returns
Type | Description |
---|---|
String | A string containing the url with an index parameter added. |
Remarks
An "index" parameter is added to the Url property for this
link to indicate which point was selected. Further, if the
X or Y axes that correspond to this CurveItem are of
Text, then an
additional parameter will be added containing the text value that
corresponds to the index
of the selected point.
The XAxis text parameter will be labeled "xtext", and
the YAxis text parameter will be labeled "ytext".
Explicit Interface Implementations
| Improve this Doc View SourceICloneable.Clone()
Implement the ICloneable interface in a typesafe manner by just calling the typed version of Clone()
Declaration
object ICloneable.Clone()
Returns
Type | Description |
---|---|
Object | A deep copy of this object |