TExcelFile.SetObjectProperty Method
Overloads
- TExcelFile.SetObjectProperty(Integer, string, TShapeOption, string)
- TExcelFile.SetObjectProperty(Integer, string, TShapeOption, Int64)
- TExcelFile.SetObjectProperty(Integer, string, TShapeOption, Double)
- TExcelFile.SetObjectProperty(Integer, string, TShapeOption, Boolean)
- TExcelFile.SetObjectProperty(Integer, string, TShapeOption, TDrawingHyperlink)
- TExcelFile.SetObjectProperty(Integer, string, TShapeOption, Integer, Boolean)
TExcelFile.SetObjectProperty(Integer, 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
Unit: FlexCel.Core
procedure TExcelFile.SetObjectProperty(const objectIndex: Integer; const objectPath: string; const shapeProperty: TShapeOption; const text: string); overload; virtual; abstract;
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
const | objectIndex | Integer | Index of the object (1-based) |
const | 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(Integer, 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" |
const | shapeProperty | TShapeOption | Property you want to change. |
const | text | string | Text you want to use. |
See also
TExcelFile.SetObjectProperty(Integer, 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
Unit: FlexCel.Core
procedure TExcelFile.SetObjectProperty(const objectIndex: Integer; const objectPath: string; const shapeProperty: TShapeOption; const value: Int64); overload; virtual; abstract;
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
const | objectIndex | Integer | Index of the object (1-based) |
const | 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(Integer, 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" |
const | shapeProperty | TShapeOption | Property you want to change. |
const | value | Int64 | Value you want to use. |
See also
TExcelFile.SetObjectProperty(Integer, 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
Unit: FlexCel.Core
procedure TExcelFile.SetObjectProperty(const objectIndex: Integer; const objectPath: string; const shapeProperty: TShapeOption; const value: Double); overload; virtual; abstract;
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
const | objectIndex | Integer | Index of the object (1-based) |
const | 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(Integer, 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" |
const | shapeProperty | TShapeOption | Property you want to change. |
const | value | Double | Value you want to use. |
See also
TExcelFile.SetObjectProperty(Integer, 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
Unit: FlexCel.Core
procedure TExcelFile.SetObjectProperty(const objectIndex: Integer; const objectPath: string; const shapeProperty: TShapeOption; const value: Boolean); overload; virtual; abstract;
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
const | objectIndex | Integer | Index of the object (1-based) |
const | 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(Integer, 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" |
const | shapeProperty | TShapeOption | Property you want to change. |
const | value | Boolean | Value you want to use. |
See also
TExcelFile.SetObjectProperty(Integer, 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
Unit: FlexCel.Core
procedure TExcelFile.SetObjectProperty(const objectIndex: Integer; const objectPath: string; const shapeProperty: TShapeOption; const value: TDrawingHyperlink); overload; virtual; abstract;
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
const | objectIndex | Integer | Index of the object (1-based) |
const | 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(Integer, 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" |
const | shapeProperty | TShapeOption | Property you want to change. For hyperlinks it should be TShapeOption.pihlShape |
const | value | TDrawingHyperlink | Value you want to use. |
See also
TExcelFile.SetObjectProperty(Integer, string, TShapeOption, Integer, 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(Integer, 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
Unit: FlexCel.Core
procedure TExcelFile.SetObjectProperty(const objectIndex: Integer; const objectPath: string; const shapeProperty: TShapeOption; const positionInSet: Integer; const value: Boolean); overload; virtual; abstract;
Parameters
<-> | Parameter | Type | Description |
---|---|---|---|
const | objectIndex | Integer | Index of the object (1-based) |
const | 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(Integer, 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" |
const | shapeProperty | TShapeOption | Property you want to change. MAKE SURE it is the LAST property in the set. |
const | positionInSet | Integer | 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. |
const | value | Boolean | Value you want to use. |