ExcelFile.SetObjectProperty Method

Overloads

ExcelFile.SetObjectProperty(Int32, String, TShapeOption, String)

Sets a STRING property for an autoshape. Verify the property expects a STRING. This is an advanced method and should be used with care. For normal use, you should use one of the standard methods. (like SetObjectText)

Syntax

Namespace: FlexCel.Core

public abstract void SetObjectProperty(Int32 objectIndex, String objectPath, TShapeOption shapeProperty, String text)

Parameters

<-> Parameter Type Description
objectIndex Int32 Index of the object (1-based)
objectPath String Index to the child object you want to change the property.
If it is a simple object, you can use String.Empty here, if not you need to get the ObjectPath from GetObjectProperties(Int32, Boolean)
If it is "absolute"(it starts with "\"), then the path includes the objectIndex, and the objectIndex is not used. An object path of "\1\2\3" is exactly the same as using objectIndex = 1 and objectPath = "2\3"
shapeProperty TShapeOption Property you want to change.
text String Text you want to use.

See also

ExcelFile.SetObjectProperty(Int32, String, TShapeOption, Int64)

Sets a LONG property for an autoshape. Verify the property expects a LONG. This is an advanced method and should be used with care. For normal use, you should use one of the standard methods.

Syntax

Namespace: FlexCel.Core

public abstract void SetObjectProperty(Int32 objectIndex, String objectPath, TShapeOption shapeProperty, Int64 value)

Parameters

<-> Parameter Type Description
objectIndex Int32 Index of the object (1-based)
objectPath String Index to the child object you want to change the property.
If it is a simple object, you can use String.Empty here, if not you need to get the ObjectPath from GetObjectProperties(Int32, Boolean)
If it is "absolute"(it starts with "\"), then the path includes the objectIndex, and the objectIndex is not used. An object path of "\1\2\3" is exactly the same as using objectIndex = 1 and objectPath = "2\3"
shapeProperty TShapeOption Property you want to change.
value Int64 Value you want to use.

See also

ExcelFile.SetObjectProperty(Int32, String, TShapeOption, Double)

Sets a DOUBLE (Encoded as 16.16) property for an autoshape. Verify the property expects a DOUBLE. This is an advanced method and should be used with care. For normal use, you should use one of the standard methods.

Syntax

Namespace: FlexCel.Core

public abstract void SetObjectProperty(Int32 objectIndex, String objectPath, TShapeOption shapeProperty, Double value)

Parameters

<-> Parameter Type Description
objectIndex Int32 Index of the object (1-based)
objectPath String Index to the child object you want to change the property.
If it is a simple object, you can use String.Empty here, if not you need to get the ObjectPath from GetObjectProperties(Int32, Boolean)
If it is "absolute"(it starts with "\"), then the path includes the objectIndex, and the objectIndex is not used. An object path of "\1\2\3" is exactly the same as using objectIndex = 1 and objectPath = "2\3"
shapeProperty TShapeOption Property you want to change.
value Double Value you want to use.

See also

ExcelFile.SetObjectProperty(Int32, String, TShapeOption, Boolean)

Sets a BOOLEAN property for an autoshape. Verify the property expects a BOOLEAN. This is an advanced method and should be used with care. For normal use, you should use one of the standard methods.

Syntax

Namespace: FlexCel.Core

public abstract void SetObjectProperty(Int32 objectIndex, String objectPath, TShapeOption shapeProperty, Boolean value)

Parameters

<-> Parameter Type Description
objectIndex Int32 Index of the object (1-based)
objectPath String Index to the child object you want to change the property.
If it is a simple object, you can use String.Empty here, if not you need to get the ObjectPath from GetObjectProperties(Int32, Boolean)
If it is "absolute"(it starts with "\"), then the path includes the objectIndex, and the objectIndex is not used. An object path of "\1\2\3" is exactly the same as using objectIndex = 1 and objectPath = "2\3"
shapeProperty TShapeOption Property you want to change.
value Boolean Value you want to use.

See also

ExcelFile.SetObjectProperty(Int32, String, TShapeOption, TDrawingHyperlink)

Sets an Hyperlink property for an autoshape. Verify the property expects a Hyperlink, currently only TShapeOption.pihlShape expects hyperlinks. This is an advanced method and should be used with care. For normal use, you should use one of the standard methods.

Syntax

Namespace: FlexCel.Core

public abstract void SetObjectProperty(Int32 objectIndex, String objectPath, TShapeOption shapeProperty, TDrawingHyperlink value)

Parameters

<-> Parameter Type Description
objectIndex Int32 Index of the object (1-based)
objectPath String Index to the child object you want to change the property.
If it is a simple object, you can use String.Empty here, if not you need to get the ObjectPath from GetObjectProperties(Int32, Boolean)
If it is "absolute"(it starts with "\"), then the path includes the objectIndex, and the objectIndex is not used. An object path of "\1\2\3" is exactly the same as using objectIndex = 1 and objectPath = "2\3"
shapeProperty TShapeOption Property you want to change. For hyperlinks it should be TShapeOption.pihlShape
value TDrawingHyperlink Value you want to use.

See also

ExcelFile.SetObjectProperty(Int32, String, TShapeOption, Int32, Boolean)

Sets a BOOLEAN property for an autoshape. Verify the property expects a BOOLEAN.

This is an advanced method, you probably want to use SetObjectProperty(Int32, String, TShapeOption, Boolean) instead. This is an advanced method and should be used with care. For normal use, you should use one of the standard methods. Note that boolean properties are all stored in the same byte of the last property in the set.

Syntax

Namespace: FlexCel.Core

public abstract void SetObjectProperty(Int32 objectIndex, String objectPath, TShapeOption shapeProperty, Int32 positionInSet, Boolean value)

Parameters

<-> Parameter Type Description
objectIndex Int32 Index of the object (1-based)
objectPath String Index to the child object you want to change the property.
If it is a simple object, you can use String.Empty here, if not you need to get the ObjectPath from GetObjectProperties(Int32, Boolean)
If it is "absolute"(it starts with "\"), then the path includes the objectIndex, and the objectIndex is not used. An object path of "\1\2\3" is exactly the same as using objectIndex = 1 and objectPath = "2\3"
shapeProperty TShapeOption Property you want to change. MAKE SURE it is the LAST property in the set.
positionInSet Int32 Boolean properties are grouped so all properties on one set are in only one value. So, the last bool property on the set is the first bit, and so on. ONLY THE LAST PROPERTY ON THE SET IS PRESENT.
value Boolean Value you want to use.

See also