asposediagram.api

Class ForeignData

Contains a MIME (Multipurpose Internet Mail Extensions) encoded BLOB of picture data, such as Windows metafile, bitmap, or OLE data.

Property Getters/Setters Summary
methodgetCompressionLevel()
method
           This attribute is only meaningful if the foreign data is a raster-based foreign object, such as a DIB, JPG, PNG, TIFF, or GIF file. The value indicates the level of compression applied to the file. Compression level is measured in hundreds of a percent.
methodgetCompressionType()
method
           This attribute is only meaningful if the foreign data is a raster-based foreign object, such as a DIB, JPG, PNG, TIFF, or GIF file. The value indicates the type of compression applied to the file. The value of the property is CompressionType integer constant.
methodgetExtentX()
method
setExtentX(value)
           This attribute is only meaningful if the foreign data is a metafile. The value indicates the horizontal extent of the metafile.
methodgetExtentY()
method
setExtentY(value)
           This attribute is only meaningful if the foreign data is a metafile. The value indicates the vertical extent of the metafile.
methodgetForeignType()
method
           Data type. The value of the property is ForeignType integer constant.
methodgetImageData()
method
           Represents image of ole object as byte array.
methodgetMappingMode()
method
           This attribute is only meaningful if the foreign data is a metafile. The value indicates the metafile mapping mode.
methodgetObjectData()
method
           Represents embedded ole object data as byte array.
methodgetObjectHeight()
method
           This attribute is only meaningful if the foreign data is an OLE2 embedded object. The value expresses the height of the object in page units.
methodgetObjectSourceFullName()
method
           Returns the source full name of the source file for the linked OLE object.
methodgetObjectType()
method
           If the ForeignType attribute is "Object", the ForeignData element must also have an ObjectType attribute. The value of the property is ObjectType integer constant.
methodgetObjectWidth()
method
           This attribute is only meaningful if the foreign data is an OLE2 embedded object. The value expresses the width of the object in page units.
methodgetShowAsIcon()
method
           This attribute is only meaningful if the foreign data is an OLE2 embedded object. The value of the property is BOOL integer constant.
methodgetValue()
method
setValue(value)
           Contains a MIME (Multipurpose Internet Mail Extensions) encoded BLOB of picture data, such as Windows metafile, bitmap, or OLE data.
 
Method Summary
methoddeepClone()
Creates deep copy of this instance.
 

    • Property Getters/Setters Detail

      • getImageData/setImageData : byte[] 

        byte[] getImageData() / setImageData(value)
        
        Represents image of ole object as byte array.
      • getObjectData/setObjectData : byte[] 

        byte[] getObjectData() / setObjectData(value)
        
        Represents embedded ole object data as byte array.
      • getForeignType/setForeignType : int 

        int getForeignType() / setForeignType(value)
        
        Data type. The value of the property is ForeignType integer constant.
      • getObjectType/setObjectType : int 

        int getObjectType() / setObjectType(value)
        
        If the ForeignType attribute is "Object", the ForeignData element must also have an ObjectType attribute. The value of the property is ObjectType integer constant.
      • getShowAsIcon/setShowAsIcon : int 

        int getShowAsIcon() / setShowAsIcon(value)
        
        This attribute is only meaningful if the foreign data is an OLE2 embedded object. The value of the property is BOOL integer constant.
      • getObjectWidth/setObjectWidth : float 

        float getObjectWidth() / setObjectWidth(value)
        
        This attribute is only meaningful if the foreign data is an OLE2 embedded object. The value expresses the width of the object in page units.
      • getObjectHeight/setObjectHeight : float 

        float getObjectHeight() / setObjectHeight(value)
        
        This attribute is only meaningful if the foreign data is an OLE2 embedded object. The value expresses the height of the object in page units.
      • getMappingMode/setMappingMode : int 

        int getMappingMode() / setMappingMode(value)
        
        This attribute is only meaningful if the foreign data is a metafile. The value indicates the metafile mapping mode.
      • getExtentX/setExtentX : float 

        float getExtentX() / setExtentX(value)
        
        This attribute is only meaningful if the foreign data is a metafile. The value indicates the horizontal extent of the metafile.
      • getExtentY/setExtentY : float 

        float getExtentY() / setExtentY(value)
        
        This attribute is only meaningful if the foreign data is a metafile. The value indicates the vertical extent of the metafile.
      • getCompressionType/setCompressionType : int 

        int getCompressionType() / setCompressionType(value)
        
        This attribute is only meaningful if the foreign data is a raster-based foreign object, such as a DIB, JPG, PNG, TIFF, or GIF file. The value indicates the type of compression applied to the file. The value of the property is CompressionType integer constant.
      • getCompressionLevel/setCompressionLevel : float 

        float getCompressionLevel() / setCompressionLevel(value)
        
        This attribute is only meaningful if the foreign data is a raster-based foreign object, such as a DIB, JPG, PNG, TIFF, or GIF file. The value indicates the level of compression applied to the file. Compression level is measured in hundreds of a percent.
      • getValue/setValue : byte[] 

        byte[] getValue() / setValue(value)
        
        Contains a MIME (Multipurpose Internet Mail Extensions) encoded BLOB of picture data, such as Windows metafile, bitmap, or OLE data.
      • getObjectSourceFullName/setObjectSourceFullName : String 

        String getObjectSourceFullName() / setObjectSourceFullName(value)
        
        Returns the source full name of the source file for the linked OLE object. Only supports setting the source full name when the file type is OleFileType.Unknown. Such as wav file ,avi file..etc..
    • Method Detail

      • deepClone

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