Package org.apache.poi.hssf.record
Class ExternalNameRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.ExternalNameRecord
EXTERNALNAME (0x0023)
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected int
short
getIx()
If this is a local name, then this is the (1 based) index of the name of the Sheet this refers to, as defined in the precedingSupBookRecord
.Ptg[]
short
getSid()
return the non static version of the id for this record.getText()
boolean
For OLE and DDE, links can be either 'automatic' or 'manual'boolean
boolean
boolean
boolean
only for OLE and DDEboolean
DDE links only.void
Write the data content of this BIFF record.void
setIx
(short ix) void
setParsedExpression
(Ptg[] ptgs) void
toString()
get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
Methods inherited from class org.apache.poi.hssf.record.Record
clone, cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
ExternalNameRecord
public ExternalNameRecord() -
ExternalNameRecord
-
-
Method Details
-
isBuiltInName
public boolean isBuiltInName()- Returns:
true
if the name is a built-in name
-
isAutomaticLink
public boolean isAutomaticLink()For OLE and DDE, links can be either 'automatic' or 'manual'- Returns:
true
if this is a automatic link
-
isPicureLink
public boolean isPicureLink()only for OLE and DDE- Returns:
true
if this is a picture link
-
isStdDocumentNameIdentifier
public boolean isStdDocumentNameIdentifier()DDE links only. Iftrue
, this denotes the 'StdDocumentName'- Returns:
true
if this denotes the 'StdDocumentName'
-
isOLELink
public boolean isOLELink() -
isIconifiedPictureLink
public boolean isIconifiedPictureLink() -
getText
- Returns:
- the standard String representation of this name
-
setText
-
getIx
public short getIx()If this is a local name, then this is the (1 based) index of the name of the Sheet this refers to, as defined in the precedingSupBookRecord
. If it isn't a local name, then it must be zero.- Returns:
- the index of the name of the Sheet this refers to
-
setIx
public void setIx(short ix) -
getParsedExpression
-
setParsedExpression
-
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
serialize
Description copied from class:StandardRecord
Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.The number of bytes written must equal the record size reported by
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-