asposediagram.api

asposediagram.api

Class User

Contains a work area for entering formulas in user-specific elements that are referred to by other elements and add-on tools.

Example:

var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("TextBoxes.vsdx");

// get page by name
page = diagram.getPages().getPage("Page-1");
// get shape by id
shape = page.getShapes().getShape(2);

// initialize user object
user = new aspose.diagram.User();
user.setName("UserDefineCell");
user.getValue().setVal("800");
// add user-defined cell
shape.getUsers().add(user);
    
diagram.save("out-CreateUserDefinedCellInShapeSheet.vsdx", aspose.diagram.SaveFileFormat.VSDX);

Constructor Summary
User()
Constructor.
 
Property Getters/Setters Summary
methodgetDel()
method
setDel(value)
           A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.
methodgetID()
method
setID(value)
           The unique ID of the element within its parent element.
methodgetName()
method
setName(value)
           The name of the element.
methodgetNameU()
method
setNameU(value)
           The universal name of the element.
methodgetPrompt()
method
setPrompt(value)
           It specifies a descriptive prompt or comment for the user-defined element.
methodgetValue()
method
setValue(value)
           Contains solution-specific, well-formed XML data that is prefixed in an explicit namespace and is stored with a document.
 
Method Summary
methoddeepClone()
Creates deep copy of this instance.
 

    • Constructor Detail

      • User

        User()
        Constructor.

    • Property Getters/Setters Detail

      • getValue/setValue : Value 

        Value getValue() / setValue(value)
        Contains solution-specific, well-formed XML data that is prefixed in an explicit namespace and is stored with a document.

      • getName/setName : String 

        String getName() / setName(value)
        The name of the element.

      • getNameU/setNameU : String 

        String getNameU() / setNameU(value)
        The universal name of the element.

      • getID/setID : int 

        int getID() / setID(value)
        The unique ID of the element within its parent element.

      • getDel/setDel : int 

        int getDel() / setDel(value)
        A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.

      • getPrompt/setPrompt : Str2Value 

        Str2Value getPrompt() / setPrompt(value)
        It specifies a descriptive prompt or comment for the user-defined element.

    • Method Detail

      • deepClone

        Object deepClone()
        Creates deep copy of this instance.
        Returns: