Search Results for

    Show / Hide Table of Contents

    ExcelFile.GetObjectPropertiesByShapeId Method

    Returns information on an object and all of its children and parents.

    Note: This method always returns a top level object. If you ask for a shape id of a shape that is contained inside other group, this method will return the first level group containing other groups that contain the shape.

    Note 2:This method is mostly for internal use. Shape ids are not guaranteed to be preserved when saving and reloading a file, so this method should only be used while editing the file with shape ids retrieved from the XlsFile object, not hardcoded shape ids. To get the object properties for a known shape in a file, give it a name and call GetObjectProperties(Int32, String, Boolean) with an objectPath of "@name\-of\-the\-shape".

    Syntax

    Namespace: FlexCel.Core

    public abstract TShapeProperties GetObjectPropertiesByShapeId(Int64 shapeId, Boolean getShapeOptions)

    Parameters

    <-> Parameter Type Description
    shapeId Int64 Identifier of the shape.
    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