<Type Name="Hyperlink" FullName="Atk.Hyperlink"> <TypeSignature Language="C#" Maintainer="auto" Value="public class Hyperlink : GLib.Object, Atk.IAction" /> <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Hyperlink extends GLib.Object implements class Atk.IAction, class GLib.IWrapper" /> <AssemblyInfo> <AssemblyName>atk-sharp</AssemblyName> <AssemblyPublicKey> </AssemblyPublicKey> </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Base> <BaseTypeName>GLib.Object</BaseTypeName> </Base> <Interfaces> <Interface> <InterfaceName>Atk.IAction</InterfaceName> </Interface> </Interfaces> <Docs> <summary>An ATK object which encapsulates a link or set of links in a hypertext document.</summary> <remarks /> </Docs> <Members> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="protected Hyperlink ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters /> <Docs> <summary>Default constructor</summary> <remarks /> </Docs> </Member> <Member MemberName=".ctor"> <MemberSignature Language="C#" Value="public Hyperlink (IntPtr raw);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" /> <MemberType>Constructor</MemberType> <ReturnValue /> <Parameters> <Parameter Name="raw" Type="System.IntPtr" /> </Parameters> <Docs> <param name="raw">Pointer to the C object.</param> <summary>Internal constructor</summary> <remarks> <para>This is an internal constructor, and should not be used by user code.</para> </remarks> </Docs> </Member> <Member MemberName="DoAction"> <MemberSignature Language="C#" Value="public bool DoAction (int i);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool DoAction(int32 i) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="i" Type="System.Int32" /> </Parameters> <Docs> <param name="i">an object of type <see cref="T:System.Int32" /></param> <summary>To be added</summary> <returns>an object of type <see cref="T:System.Boolean" /></returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="EmitLinkActivated"> <MemberSignature Language="C#" Value="protected void EmitLinkActivated ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void EmitLinkActivated() cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added.</summary> <remarks>To be added.</remarks> <since version="Gtk# 3.0" /> </Docs> </Member> <Member MemberName="EndIndex"> <MemberSignature Language="C#" Value="public int EndIndex { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance int32 EndIndex" /> <MemberType>Property</MemberType> <Attributes> <Attribute> <AttributeName>GLib.Property("end-index")</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> <summary>Gets the index with the hypertext document at which this link ends.</summary> <value> the index with the hypertext document at which this link ends</value> <remarks /> </Docs> </Member> <Member MemberName="GetDescription"> <MemberSignature Language="C#" Value="public string GetDescription (int i);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string GetDescription(int32 i) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="i" Type="System.Int32" /> </Parameters> <Docs> <param name="i">an object of type <see cref="T:System.Int32" /></param> <summary>To be added</summary> <returns>an object of type <see cref="T:System.String" /></returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="GetKeybinding"> <MemberSignature Language="C#" Value="public string GetKeybinding (int i);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string GetKeybinding(int32 i) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="i" Type="System.Int32" /> </Parameters> <Docs> <param name="i">an object of type <see cref="T:System.Int32" /></param> <summary>To be added</summary> <returns>an object of type <see cref="T:System.String" /></returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="GetLocalizedName"> <MemberSignature Language="C#" Value="public string GetLocalizedName (int i);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string GetLocalizedName(int32 i) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="i" Type="System.Int32" /> </Parameters> <Docs> <param name="i">a <see cref="T:System.Int32" /></param> <summary>To be added</summary> <returns>a <see cref="T:System.String" /></returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="GetName"> <MemberSignature Language="C#" Value="public string GetName (int i);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance string GetName(int32 i) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="i" Type="System.Int32" /> </Parameters> <Docs> <param name="i">an object of type <see cref="T:System.Int32" /></param> <summary>To be added</summary> <returns>an object of type <see cref="T:System.String" /></returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="GetObject"> <MemberSignature Language="C#" Value="public Atk.Object GetObject (int i);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Atk.Object GetObject(int32 i) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>Atk.Object</ReturnType> </ReturnValue> <Parameters> <Parameter Name="i" Type="System.Int32" /> </Parameters> <Docs> <param name="i">an object of type <see cref="T:System.Int32" /></param> <summary>Returns the item associated with this hyperlinks nth anchor.</summary> <returns>an object of type <see cref="T:Atk.Object" /></returns> <remarks>For instance, the returned <see cref="T:Atk.Object" /> will implement <see cref="T:Atk.Text" /> if the link is a text hyperlink, <see cref="T:Atk.Image" /> if the link is an image hyperlink etc. <para> Multiple anchors are primarily used by client-side image maps. </para></remarks> </Docs> </Member> <Member MemberName="GetUri"> <MemberSignature Language="C#" Value="public string GetUri (int i);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetUri(int32 i) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="i" Type="System.Int32" /> </Parameters> <Docs> <param name="i"> a (zero-index) integer specifying the desired anchor</param> <summary>Get a the URI associated with the anchor specified by <paramref name="i" /></summary> <returns> a string specifying the URI</returns> <remarks>Multiple anchors are primarily used by client-side image maps.</remarks> </Docs> </Member> <Member MemberName="GType"> <MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" /> <MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>GLib.GType</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>GType Property.</summary> <value>a <see cref="T:GLib.GType" /></value> <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Atk.Hyperlink" />.</remarks> </Docs> </Member> <Member MemberName="IsInline"> <MemberSignature Language="C#" Value="public bool IsInline { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance bool IsInline" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Indicates whether the link currently displays some or all of its content inline.</summary> <value> whether or not this link displays its content inline.</value> <remarks>Ordinary HTML links will usually return <see langword="false" />, but an inline <src> HTML element will return <see langword="true" />.</remarks> </Docs> </Member> <Member MemberName="IsSelectedLink"> <MemberSignature Language="C#" Value="public bool IsSelectedLink { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance bool IsSelectedLink" /> <MemberType>Property</MemberType> <Attributes> <Attribute> <AttributeName>System.Obsolete</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added</summary> <value>a <see cref="T:System.Boolean" /></value> <remarks>To be added</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="IsValid"> <MemberSignature Language="C#" Value="public bool IsValid { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance bool IsValid" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Since the document that a link is associated with may have changed this method returns <see langword="true" /> if the link is still valid (with respect to the document it references) and <see langword="false" /> otherwise.</summary> <value> whether or not this link is still valid</value> <remarks /> </Docs> </Member> <Member MemberName="LinkActivated"> <MemberSignature Language="C#" Value="public event EventHandler LinkActivated;" /> <MemberSignature Language="ILAsm" Value=".event class System.EventHandler LinkActivated" /> <MemberType>Event</MemberType> <Attributes> <Attribute> <AttributeName>GLib.Signal("link_activated")</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.EventHandler</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added</summary> <remarks>To be added</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="NActions"> <MemberSignature Language="C#" Value="public int NActions { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance int32 NActions" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> <summary>The number of actions.</summary> <value>an object of type <see cref="T:System.Int32" /></value> <remarks /> </Docs> </Member> <Member MemberName="NAnchors"> <MemberSignature Language="C#" Value="public int NAnchors { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance int32 NAnchors" /> <MemberType>Property</MemberType> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> <summary>Gets the number of anchors associated with this hyperlink.</summary> <value>the number of anchors associated with this hyperlink</value> <remarks /> </Docs> </Member> <Member MemberName="NumberOfAnchors"> <MemberSignature Language="C#" Value="public int NumberOfAnchors { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance int32 NumberOfAnchors" /> <MemberType>Property</MemberType> <Attributes> <Attribute> <AttributeName>GLib.Property("number-of-anchors")</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added</summary> <value>a <see cref="T:System.Int32" /></value> <remarks>To be added</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="OnGetEndIndex"> <MemberSignature Language="C#" Value="protected virtual int OnGetEndIndex ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance int32 OnGetEndIndex() cil managed" /> <MemberType>Method</MemberType> <Attributes> <Attribute> <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideGetEndIndex", Type=typeof(Atk.Hyperlink))</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <since version="Gtk# 3.0" /> </Docs> </Member> <Member MemberName="OnGetNAnchors"> <MemberSignature Language="C#" Value="protected virtual int OnGetNAnchors ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance int32 OnGetNAnchors() cil managed" /> <MemberType>Method</MemberType> <Attributes> <Attribute> <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideGetNAnchors", Type=typeof(Atk.Hyperlink))</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <since version="Gtk# 3.0" /> </Docs> </Member> <Member MemberName="OnGetObject"> <MemberSignature Language="C#" Value="protected virtual Atk.Object OnGetObject (int i);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class Atk.Object OnGetObject(int32 i) cil managed" /> <MemberType>Method</MemberType> <Attributes> <Attribute> <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideGetObject", Type=typeof(Atk.Hyperlink))</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>Atk.Object</ReturnType> </ReturnValue> <Parameters> <Parameter Name="i" Type="System.Int32" /> </Parameters> <Docs> <param name="i">To be added.</param> <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <since version="Gtk# 3.0" /> </Docs> </Member> <Member MemberName="OnGetStartIndex"> <MemberSignature Language="C#" Value="protected virtual int OnGetStartIndex ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance int32 OnGetStartIndex() cil managed" /> <MemberType>Method</MemberType> <Attributes> <Attribute> <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideGetStartIndex", Type=typeof(Atk.Hyperlink))</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <since version="Gtk# 3.0" /> </Docs> </Member> <Member MemberName="OnGetUri"> <MemberSignature Language="C#" Value="protected virtual string OnGetUri (int i);" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance string OnGetUri(int32 i) cil managed" /> <MemberType>Method</MemberType> <Attributes> <Attribute> <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideGetUri", Type=typeof(Atk.Hyperlink))</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.String</ReturnType> </ReturnValue> <Parameters> <Parameter Name="i" Type="System.Int32" /> </Parameters> <Docs> <param name="i">To be added.</param> <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <since version="Gtk# 3.0" /> </Docs> </Member> <Member MemberName="OnIsSelectedLink"> <MemberSignature Language="C#" Value="protected virtual bool OnIsSelectedLink ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool OnIsSelectedLink() cil managed" /> <MemberType>Method</MemberType> <Attributes> <Attribute> <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideIsSelectedLink", Type=typeof(Atk.Hyperlink))</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <since version="Gtk# 3.0" /> </Docs> </Member> <Member MemberName="OnIsValid"> <MemberSignature Language="C#" Value="protected virtual bool OnIsValid ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool OnIsValid() cil managed" /> <MemberType>Method</MemberType> <Attributes> <Attribute> <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideIsValid", Type=typeof(Atk.Hyperlink))</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <since version="Gtk# 3.0" /> </Docs> </Member> <Member MemberName="OnLinkActivated"> <MemberSignature Language="C#" Value="protected virtual void OnLinkActivated ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnLinkActivated() cil managed" /> <MemberType>Method</MemberType> <Attributes> <Attribute> <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideLinkActivated", Type=typeof(Atk.Hyperlink))</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Void</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>Default handler for the <see cref="M:Atk.Hyperlink.LinkActivated" /> event.</summary> <remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Atk.Hyperlink.LinkActivated" /> event.</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="OnLinkState"> <MemberSignature Language="C#" Value="protected virtual uint OnLinkState ();" /> <MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance unsigned int32 OnLinkState() cil managed" /> <MemberType>Method</MemberType> <Attributes> <Attribute> <AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideLinkState", Type=typeof(Atk.Hyperlink))</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.UInt32</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added.</summary> <returns>To be added.</returns> <remarks>To be added.</remarks> <since version="Gtk# 3.0" /> </Docs> </Member> <Member MemberName="SelectedLink"> <MemberSignature Language="C#" Value="public bool SelectedLink { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance bool SelectedLink" /> <MemberType>Property</MemberType> <Attributes> <Attribute> <AttributeName>GLib.Property("selected-link")</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters /> <Docs> <summary>To be added</summary> <value>a <see cref="T:System.Boolean" /></value> <remarks>To be added</remarks> <since version="Gtk# 2.4" /> </Docs> </Member> <Member MemberName="SetDescription"> <MemberSignature Language="C#" Value="public bool SetDescription (int i, string desc);" /> <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool SetDescription(int32 i, string desc) cil managed" /> <MemberType>Method</MemberType> <ReturnValue> <ReturnType>System.Boolean</ReturnType> </ReturnValue> <Parameters> <Parameter Name="i" Type="System.Int32" /> <Parameter Name="desc" Type="System.String" /> </Parameters> <Docs> <param name="i">an object of type <see cref="T:System.Int32" /></param> <param name="desc">an object of type <see cref="T:System.String" /></param> <summary>To be added</summary> <returns>an object of type <see cref="T:System.Boolean" /></returns> <remarks>To be added</remarks> </Docs> </Member> <Member MemberName="StartIndex"> <MemberSignature Language="C#" Value="public int StartIndex { get; }" /> <MemberSignature Language="ILAsm" Value=".property instance int32 StartIndex" /> <MemberType>Property</MemberType> <Attributes> <Attribute> <AttributeName>GLib.Property("start-index")</AttributeName> </Attribute> </Attributes> <ReturnValue> <ReturnType>System.Int32</ReturnType> </ReturnValue> <Docs> <summary>Gets the index with the hypertext document at which this link begins.</summary> <value> the index with the hypertext document at which this link begins</value> <remarks /> </Docs> </Member> </Members> </Type>