asposecells.api

Class Slicer

summary description of Slicer View

Property Getters/Setters Summary
methodgetAlternativeText()
method
           Returns or sets the descriptive (alternative) text string of the Slicer object.
methodgetCaption()
method
setCaption(value)
           Returns or sets the caption of the specified slicer.
methodgetCaptionVisible()
method
           Returns or sets whether the header that displays the slicer Caption is visible the default value is true
methodgetColumnWidth()
method
           Returns or sets the width, in points, of each column in the slicer.
methodgetColumnWidthPixel()
method
           Gets or sets the width in unit of pixels for each column of the slicer. 
methodgetHeight()
method
setHeight(value)
           Returns or sets the height of the specified slicer, in points.
methodgetHeightPixel()
method
           Returns or sets the height of the specified slicer, in pixels.
methodisLocked()
method
setLocked(value)
           Indicates whether the slicer shape is locked.
methodisPrintable()
method
           Indicates whether the slicer object is printable.
methodgetLeftPixel()
method
           Returns or sets the horizontal offset of slicer shape from its left column, in pixels.
methodgetLockedAspectRatio()
method
           Indicates whether locking aspect ratio.
methodgetLockedPosition()
method
           Indicates whether the specified slicer can be moved or resized by using the user interface.
methodgetName()
method
setName(value)
           Returns or sets the name of the specified slicer
methodgetNumberOfColumns()
method
           Returns or sets the number of columns in the specified slicer.
methodgetParent()
Returns the Worksheet object that represents the sheet that contains the slicer. Read-only.
methodgetPlacement()
method
           Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet. The value of the property is PlacementType integer constant.
methodgetRowHeight()
method
           Returns or sets the height, in points, of each row in the specified slicer.
methodgetRowHeightPixel()
method
           Returns or sets the height, in pixels, of each row in the specified slicer.
methodgetSlicerCache()
Returns the SlicerCache object associated with the slicer. Read-only.
methodgetStyleType()
method
           Specify the type of Built-in slicer style the default type is SlicerStyleLight1 The value of the property is SlicerStyleType integer constant.
methodgetTitle()
method
setTitle(value)
           Specifies the title of the current Slicer object.
methodgetTopPixel()
method
           Returns or sets the vertical offset of slicer shape from its top row, in pixels.
methodgetWidth()
method
setWidth(value)
           Returns or sets the width of the specified slicer, in points.
methodgetWidthPixel()
method
           Returns or sets the width of the specified slicer, in pixels.
 
Method Summary
methodaddPivotConnection(pivot)
Adds PivotTable connection.
methodrefresh()
Refreshing the slicer.Meanwhile, Refreshing and Calculating relative PivotTables.
methodremovePivotConnection(pivot)
Removes PivotTable connection.
 

    • Property Getters/Setters Detail

      • getTitle/setTitle : String 

        String getTitle() / setTitle(value)
        
        Specifies the title of the current Slicer object.
      • getAlternativeText/setAlternativeText : String 

        String getAlternativeText() / setAlternativeText(value)
        
        Returns or sets the descriptive (alternative) text string of the Slicer object.
      • isPrintable/setPrintable : boolean 

        boolean isPrintable() / setPrintable(value)
        
        Indicates whether the slicer object is printable.
      • isLocked/setLocked : boolean 

        boolean isLocked() / setLocked(value)
        
        Indicates whether the slicer shape is locked.
      • getPlacement/setPlacement : int 

        int getPlacement() / setPlacement(value)
        
        Represents the way the drawing object is attached to the cells below it. The property controls the placement of an object on a worksheet. The value of the property is PlacementType integer constant.
      • getLockedAspectRatio/setLockedAspectRatio : boolean 

        boolean getLockedAspectRatio() / setLockedAspectRatio(value)
        
        Indicates whether locking aspect ratio.
      • getLockedPosition/setLockedPosition : boolean 

        boolean getLockedPosition() / setLockedPosition(value)
        
        Indicates whether the specified slicer can be moved or resized by using the user interface.
      • getSlicerCache : SlicerCache 

        SlicerCache getSlicerCache()
        
        Returns the SlicerCache object associated with the slicer. Read-only.
      • getParent : Worksheet 

        Worksheet getParent()
        
        Returns the Worksheet object that represents the sheet that contains the slicer. Read-only.
      • getStyleType/setStyleType : int 

        int getStyleType() / setStyleType(value)
        
        Specify the type of Built-in slicer style the default type is SlicerStyleLight1 The value of the property is SlicerStyleType integer constant.
      • getName/setName : String 

        String getName() / setName(value)
        
        Returns or sets the name of the specified slicer
      • getCaption/setCaption : String 

        String getCaption() / setCaption(value)
        
        Returns or sets the caption of the specified slicer.
      • getCaptionVisible/setCaptionVisible : boolean 

        boolean getCaptionVisible() / setCaptionVisible(value)
        
        Returns or sets whether the header that displays the slicer Caption is visible the default value is true
      • getNumberOfColumns/setNumberOfColumns : int 

        int getNumberOfColumns() / setNumberOfColumns(value)
        
        Returns or sets the number of columns in the specified slicer.
      • getLeftPixel/setLeftPixel : int 

        int getLeftPixel() / setLeftPixel(value)
        
        Returns or sets the horizontal offset of slicer shape from its left column, in pixels.
      • getTopPixel/setTopPixel : int 

        int getTopPixel() / setTopPixel(value)
        
        Returns or sets the vertical offset of slicer shape from its top row, in pixels.
      • getWidth/setWidth : float 

        float getWidth() / setWidth(value)
        
        Returns or sets the width of the specified slicer, in points.
      • getWidthPixel/setWidthPixel : int 

        int getWidthPixel() / setWidthPixel(value)
        
        Returns or sets the width of the specified slicer, in pixels.
      • getHeight/setHeight : float 

        float getHeight() / setHeight(value)
        
        Returns or sets the height of the specified slicer, in points.
      • getHeightPixel/setHeightPixel : int 

        int getHeightPixel() / setHeightPixel(value)
        
        Returns or sets the height of the specified slicer, in pixels.
      • getColumnWidthPixel/setColumnWidthPixel : int 

        int getColumnWidthPixel() / setColumnWidthPixel(value)
        
        Gets or sets the width in unit of pixels for each column of the slicer. 
      • getColumnWidth/setColumnWidth : float 

        float getColumnWidth() / setColumnWidth(value)
        
        Returns or sets the width, in points, of each column in the slicer.
      • getRowHeightPixel/setRowHeightPixel : int 

        int getRowHeightPixel() / setRowHeightPixel(value)
        
        Returns or sets the height, in pixels, of each row in the specified slicer.
      • getRowHeight/setRowHeight : float 

        float getRowHeight() / setRowHeight(value)
        
        Returns or sets the height, in points, of each row in the specified slicer.
    • Method Detail

      • addPivotConnection

         addPivotConnection(pivot)
        Adds PivotTable connection.
        Parameters:
        pivot: PivotTable - The PivotTable object
      • removePivotConnection

         removePivotConnection(pivot)
        Removes PivotTable connection.
        Parameters:
        pivot: PivotTable - The PivotTable object
      • refresh

         refresh()
        Refreshing the slicer.Meanwhile, Refreshing and Calculating relative PivotTables.