Search Results for

    Show / Hide Table of Contents

    ExcelFile.GetObjectProperties Method

    Overloads

    • ExcelFile.GetObjectProperties(Int32, Boolean)
    • ExcelFile.GetObjectProperties(Int32, String, Boolean)

    ExcelFile.GetObjectProperties(Int32, Boolean)

    Returns information on an object and all of its children. If the shape doesn't exist, this method returns null.

    Syntax

    Namespace: FlexCel.Core

    public TShapeProperties GetObjectProperties(Int32 objectIndex, Boolean getShapeOptions)

    Parameters

    <-> Parameter Type Description
    objectIndex Int32 Index of the object (1-based)
    getShapeOptions Boolean When true, shape options will be retrieved. As this can be a slow operation, only specify true when you really need those options.

    See also

    • ExcelFile

    ExcelFile.GetObjectProperties(Int32, String, Boolean)

    Returns information on an object and all of its children. If the shape doesn't exist, this method returns null.

    Syntax

    Namespace: FlexCel.Core

    public abstract TShapeProperties GetObjectProperties(Int32 objectIndex, String objectPath, Boolean getShapeOptions)

    Parameters

    <-> Parameter Type Description
    objectIndex Int32 Index of the object (1-based)
    objectPath String Index to the child object you want to change the text.
    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".
    You might also use the name of the object as objectpath by writing "@" at the start of the name, like in GetObjectProperties\(\-1, "@myobjectname", true);
    getShapeOptions Boolean When true, shape options will be retrieved. As this can be a slow operation, only specify true when you really need those options.

    See also

    • ExcelFile
    In This Article
    Back to top FlexCel Studio for the .NET Framework v7.24.0.0
    © 2002 - 2025 tmssoftware.com