/* ====================================================================
|
Licensed to the Apache Software Foundation (ASF) Under one or more
|
contributor license agreements. See the NOTICE file distributed with
|
this work for Additional information regarding copyright ownership.
|
The ASF licenses this file to You Under the Apache License, Version 2.0
|
(the "License"); you may not use this file except in compliance with
|
the License. You may obtain a copy of the License at
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
Unless required by applicable law or agreed to in writing, software
|
distributed Under the License is distributed on an "AS Is" BASIS,
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
See the License for the specific language governing permissions and
|
limitations Under the License.
|
==================================================================== */
|
namespace HH.WMS.Utils.NPOI.HSSF.UserModel
|
{
|
using System;
|
using System.Text;
|
using System.Collections;
|
using HH.WMS.Utils.NPOI.DDF;
|
using HH.WMS.Utils.NPOI.HSSF.Record;
|
using HH.WMS.Utils.NPOI.HSSF.Util;
|
using HH.WMS.Utils.NPOI.SS.UserModel;
|
|
/// <summary>
|
/// Represents an Excel hyperlink.
|
/// </summary>
|
/// <remarks>@author Yegor Kozlov (yegor at apache dot org)</remarks>
|
public class HSSFHyperlink:IHyperlink
|
{
|
/**
|
* Low-level record object that stores the actual hyperlink data
|
*/
|
public HyperlinkRecord record = null;
|
|
/**
|
* If we Create a new hypelrink remember its type
|
*/
|
protected int link_type;
|
|
/// <summary>
|
/// Initializes a new instance of the <see cref="HSSFHyperlink"/> class.
|
/// </summary>
|
/// <param name="type">The type of hyperlink to Create.</param>
|
public HSSFHyperlink(HyperlinkType type)
|
{
|
this.link_type = (int)type;
|
record = new HyperlinkRecord();
|
switch (type)
|
{
|
case HyperlinkType.URL:
|
case HyperlinkType.EMAIL:
|
record.CreateUrlLink();
|
break;
|
case HyperlinkType.FILE:
|
record.CreateFileLink();
|
break;
|
case HyperlinkType.DOCUMENT:
|
record.CreateDocumentLink();
|
break;
|
}
|
}
|
|
/// <summary>
|
/// Initializes a new instance of the <see cref="HSSFHyperlink"/> class.
|
/// </summary>
|
/// <param name="record">The record.</param>
|
public HSSFHyperlink(HyperlinkRecord record)
|
{
|
this.record = record;
|
}
|
|
/// <summary>
|
/// Gets or sets the row of the first cell that Contains the hyperlink
|
/// </summary>
|
/// <value>the 0-based row of the cell that Contains the hyperlink.</value>
|
public int FirstRow
|
{
|
get { return record.FirstRow; }
|
set { record.FirstRow=value; }
|
}
|
|
/// <summary>
|
/// Gets or sets the row of the last cell that Contains the hyperlink
|
/// </summary>
|
/// <value>the 0-based row of the last cell that Contains the hyperlink</value>
|
public int LastRow
|
{
|
get { return record.LastRow; }
|
set { record.LastRow=value; }
|
}
|
|
|
/// <summary>
|
/// Gets or sets the column of the first cell that Contains the hyperlink
|
/// </summary>
|
/// <value>the 0-based column of the first cell that Contains the hyperlink</value>
|
public int FirstColumn
|
{
|
get { return record.FirstColumn; }
|
set { record.FirstColumn=value; }
|
}
|
|
/// <summary>
|
/// Gets or sets the column of the last cell that Contains the hyperlink
|
/// </summary>
|
/// <value>the 0-based column of the last cell that Contains the hyperlink</value>
|
public int LastColumn
|
{
|
get { return record.LastColumn; }
|
set { record.LastColumn=value; }
|
}
|
|
/// <summary>
|
/// Gets or sets Hypelink Address. Depending on the hyperlink type it can be URL, e-mail, patrh to a file, etc.
|
/// </summary>
|
/// <value>the Address of this hyperlink</value>
|
public String Address
|
{
|
get
|
{
|
return record.Address;
|
}
|
set { record.Address = value; }
|
}
|
|
/// <summary>
|
/// Gets or sets the text mark.
|
/// </summary>
|
/// <value>The text mark.</value>
|
public String TextMark
|
{
|
get { return record.TextMark; }
|
set { record.TextMark = value; }
|
}
|
|
/// <summary>
|
/// Gets or sets the short filename.
|
/// </summary>
|
/// <value>The short filename.</value>
|
public String ShortFilename
|
{
|
get { return record.ShortFilename; }
|
set { record.ShortFilename = value; }
|
}
|
|
/// <summary>
|
/// Gets or sets the text label for this hyperlink
|
/// </summary>
|
/// <value>text to Display</value>
|
public String Label
|
{
|
get
|
{
|
return record.Label;
|
}
|
set
|
{
|
record.Label=value;
|
}
|
}
|
|
/// <summary>
|
/// Gets the type of this hyperlink
|
/// </summary>
|
/// <value>the type of this hyperlink</value>
|
public HyperlinkType Type
|
{
|
get { return (HyperlinkType)link_type; }
|
}
|
}
|
}
|
