asposediagram.api

Class DataColumn

Defines how a data column appears in the External Data window in the Visio user interface and qualifies the data in the column by defining its data type and formatting.

Constructor Summary
DataColumn()
Constructor.
 
Property Getters/Setters Summary
methodgetCalendar()
method
           Calendar ID of the data column.
methodgetColumnNameID()
method
           External name of the data column. Appears in the headings in the External Data window and in labels in data graphics.
methodgetCurrency()
method
           Currency ID of the data column.
methodgetDataType()
method
           Type of the data in the data column.
methodgetDegree()
method
setDegree(value)
           Specifies the degree (power) of the units, for example squared, or cubed. The default (attribute absent) is 1.
methodgetDisplayOrder()
method
           Defines the display position of the data column in the External Data window, from the left-most column (0) to the right-most column (largest value).
methodgetDisplayWidth()
method
           Width of the data column in the External Data window.
methodgetHyperlink()
method
           Whether the data column creates a hyperlink in a shape when the shape is linked to data. The value of the property is BOOL integer constant.
methodgetLabel()
method
setLabel(value)
           Label of the data column.
methodgetLangID()
method
setLangID(value)
           The language ID of the data column
methodgetMapped()
method
setMapped(value)
           Specifies whether the column is visible in the External Data window. True (1) for the column to be visible; false (0) for the column not to be visible. The default (attribute absent) is for the column to be visible. The value of the property is BOOL integer constant.
methodgetName()
method
setName(value)
           Internal name of the data column. Used as the row name for the shape-data item (custom property) added to a shape when the shape is linked to a data row.
methodgetOrigLabel()
method
           Column label returned to Visio by the underlying ADO interface.
methodgetUnitType()
method
           Unit type of the data in the data column.
 

    • Constructor Detail

      • DataColumn

        DataColumn()
        Constructor.
    • Property Getters/Setters Detail

      • getColumnNameID/setColumnNameID : String 

        String getColumnNameID() / setColumnNameID(value)
        
        External name of the data column. Appears in the headings in the External Data window and in labels in data graphics.
      • getName/setName : String 

        String getName() / setName(value)
        
        Internal name of the data column. Used as the row name for the shape-data item (custom property) added to a shape when the shape is linked to a data row.
      • getLabel/setLabel : String 

        String getLabel() / setLabel(value)
        
        Label of the data column.
      • getOrigLabel/setOrigLabel : String 

        String getOrigLabel() / setOrigLabel(value)
        
        Column label returned to Visio by the underlying ADO interface.
      • getLangID/setLangID : long 

        long getLangID() / setLangID(value)
        
        The language ID of the data column
      • getCalendar/setCalendar : int 

        int getCalendar() / setCalendar(value)
        
        Calendar ID of the data column.
      • getDataType/setDataType : int 

        int getDataType() / setDataType(value)
        
        Type of the data in the data column.
      • getUnitType/setUnitType : String 

        String getUnitType() / setUnitType(value)
        
        Unit type of the data in the data column.
      • getCurrency/setCurrency : int 

        int getCurrency() / setCurrency(value)
        
        Currency ID of the data column.
      • getDegree/setDegree : long 

        long getDegree() / setDegree(value)
        
        Specifies the degree (power) of the units, for example squared, or cubed. The default (attribute absent) is 1.
      • getDisplayWidth/setDisplayWidth : long 

        long getDisplayWidth() / setDisplayWidth(value)
        
        Width of the data column in the External Data window.
      • getDisplayOrder/setDisplayOrder : long 

        long getDisplayOrder() / setDisplayOrder(value)
        
        Defines the display position of the data column in the External Data window, from the left-most column (0) to the right-most column (largest value).
      • getMapped/setMapped : int 

        int getMapped() / setMapped(value)
        
        Specifies whether the column is visible in the External Data window. True (1) for the column to be visible; false (0) for the column not to be visible. The default (attribute absent) is for the column to be visible. The value of the property is BOOL integer constant.
      • getHyperlink/setHyperlink : int 

        int getHyperlink() / setHyperlink(value)
        
        Whether the data column creates a hyperlink in a shape when the shape is linked to data. The value of the property is BOOL integer constant.