Struct oox::shared::drawingml::core::Hyperlink

pub struct Hyperlink {
    pub relationship_id: Option<RelationshipId>,
    pub invalid_url: Option<String>,
    pub action: Option<String>,
    pub target_frame: Option<String>,
    pub tooltip: Option<String>,
    pub history: Option<bool>,
    pub highlight_click: Option<bool>,
    pub end_sound: Option<bool>,
    pub sound: Option<EmbeddedWAVAudioFile>,
}

Fields

relationship_id: Option<RelationshipId>

Specifies the relationship id that when looked up in this slides relationship file contains the target of this hyperlink. This attribute cannot be omitted.

invalid_url: Option<String>

Specifies the URL when it has been determined by the generating application that the URL is invalid. That is the generating application can still store the URL but it is known that this URL is not correct.

action: Option<String>

Specifies an action that is to be taken when this hyperlink is activated. This can be used to specify a slide to be navigated to or a script of code to be run.

target_frame: Option<String>

Specifies the target frame that is to be used when opening this hyperlink. When the hyperlink is activated this attribute is used to determine if a new window is launched for viewing or if an existing one can be used. If this attribute is omitted, than a new window is opened.

tooltip: Option<String>

Specifies the tooltip that should be displayed when the hyperlink text is hovered over with the mouse. If this attribute is omitted, than the hyperlink text itself can be displayed.

history: Option<bool>

Specifies whether to add this URI to the history when navigating to it. This allows for the viewing of this presentation without the storing of history information on the viewing machine. If this attribute is omitted, then a value of 1 or true is assumed.

Defaults to true

highlight_click: Option<bool>

Specifies if this attribute has already been used within this document. That is when a hyperlink has already been visited that this attribute would be utilized so the generating application can determine the color of this text. If this attribute is omitted, then a value of 0 or false is implied.

Defaults to false

end_sound: Option<bool>

Specifies if the URL in question should stop all sounds that are playing when it is clicked.

Defaults to false

sound: Option<EmbeddedWAVAudioFile>

Methods

impl Hyperlink

pub fn from_xml_element(xml_node: &XmlNode) -> Result<Self>

Trait Implementations

impl Clone for Hyperlink

fn clone(&self) -> Hyperlink

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Hyperlink

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Hyperlink

fn default() -> Hyperlink

Returns the "default value" for a type.

impl PartialEq<Hyperlink> for Hyperlink

fn eq(&self, other: &Hyperlink) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Hyperlink) -> bool

This method tests for !=.

impl StructuralPartialEq for Hyperlink