IShapeOptionList Interface

This class holds a list of key/values pairs specifying the options for a shape. To Get a value from it, use: ShapeOptionList[TShapeOption.xxx];

Syntax

Unit: FlexCel.Core

IShapeOptionList = interface(IInterface);

Methods

Name	Description
As1616	Returns a float (Expressed as 16.16) property if it exists, otherwise the default value.
AsBool	Overloaded AsBool(TShapeOption, Boolean) AsBool(TShapeOption, Boolean, Integer)
AsByteArray	Returns a byte array property if it exists, otherwise null.
AsHyperLink	Overloaded AsHyperLink(TShapeOption, TDrawingHyperlink) AsHyperLink(TCoreExcelFile, TShapeOption, TDrawingHyperlink)
AsImage	Returns a byte array with the image if it exists, otherwise null. Note that for SVG images, xlsx files store both a PNG and SVG image. In those cases, for backward compatibility reasons, this method will return the PNG image. To get the SVG, call AsImageAlternate
AsImageAlternate	Returns a byte array with the image if it exists, otherwise null. Note that for SVG images, xlsx files store both a PNG and SVG image. In those cases, this method will return the SVG image. To get the PNG, call AsImage
AsInt32	Returns a long property if it exists, otherwise the default value. Note: This method will return negative numbers if the number is bigger than 65536.
AsLong	Returns a long property if it exists, otherwise the default value. Note: This method will always assume a positive number. To get a signed int, use AsSignedLong
AsSignedLong	Returns a long property if it exists, otherwise the default value. Note: This method will return negative numbers if the number is bigger than 65536. To get an unsigned int, use AsLong
AsUInt32	Returns a long property if it exists, otherwise the default value. Note: This method will always return positive numbers. To get an signed int, use AsInt32
AsUnicodeString	Returns an unicode property if it exists, otherwise the default value.
Clone	Creates a deep copy of the object.
GetGradientStopAlpha	Returns a list of individual alpha values for the stops of a gradient. This is not available in xls files, only xlsx. The alpha values determine the opacity of each stop, with 0 being completely transparent and 255 being completely opaque. This value might be null if there is no gradient in the pattern, or if the individual stops don't have a defined alpha.
SetBytes	Sets a property with arbitrary bytes.
SetImage	Sets a property with the bytes of an image.
SetValue	Overloaded SetValue(TShapeOption, Double) SetValue(TShapeOption, Boolean) SetValue(TShapeOption, TDrawingHyperlink) SetValue(TShapeOption, string)

Properties

Name	Description
Item[const key]	Gets the value for a key. Value can be a long or a string, depending on the type of property.