TShapeOptionList Class

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

Namespace: FlexCel.Core

public class TShapeOptionList: IEnumerable, ICloneable, IEnumerable<TShapeOption>

Methods

Name	Description
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
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.
As1616	Returns a double (Expressed as 16.16) property if it exists, otherwise the default value.
ShapeOptionType	Returns the type of property that a specific shape option is.
AsBool	Overloaded AsBool(TShapeOption, Boolean) AsBool(TShapeOption, Boolean, Int32)
CalcBoolKey	Returns the position of a boolean in a set. This is an advanced method and should normally not be used.
AsUnicodeString	Returns an unicode property if it exists, otherwise the default value.
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.
AsHyperLink	Overloaded AsHyperLink(TShapeOption, TDrawingHyperlink) AsHyperLink(ExcelFile, TShapeOption, TDrawingHyperlink)
AsByteArray	Returns a byte array property if it exists, otherwise null.
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
SetValue	Overloaded SetValue(TShapeOption, Double) SetValue(TShapeOption, Boolean) SetValue(TShapeOption, TDrawingHyperlink) SetValue(TShapeOption, String)
SetImage	Sets a property with the bytes of an image.
SetBytes	Sets a property with arbitrary bytes.
Equals	Returns true if 2 instances of this class have the same values.
GetHashCode	Hashcode for the object.
GetEnumerator	Gets the enumerator for this class.
Clone	Creates a deep copy of the object.

Properties

Name	Description
Keys	A list of the shape options in the list.