com.aspose.cells
Classes 
AboveAverage
AbstractCalculationEngine
AbstractCalculationMonitor
AbstractGlobalizationSettings
AbstractInterruptMonitor
AbstractTextLoadOptions
ActiveXControl
ActiveXControlBase
ArcShape
Area
AutoFilter
AutoFitterOptions
AutomaticFill
AutoNumberedBulletValue
Axis
AxisBins
BaseShapeGuide
Bevel
Border
BorderCollection
BuiltInDocumentPropertyCollection
Bullet
BulletValue
Button
CalculationCell
CalculationData
CalculationOptions
Cell
CellArea
Cells
CellsColor
CellsDataTableFactory
CellsDrawing
CellsException
CellsFactory
CellsHelper
CellWatch
CellWatchCollection
CharacterBulletValue
Chart
ChartArea
ChartCollection
ChartDataTable
ChartFrame
ChartGlobalizationSettings
ChartPoint
ChartPointCollection
ChartShape
ChartTextFrame
CheckBox
CheckBoxActiveXControl
CheckBoxCollection
CollectionBase
Color
ColorFilter
ColorHelper
ColorScale
Column
ColumnCollection
ComboBox
ComboBoxActiveXControl
CommandButtonActiveXControl
Comment
CommentCollection
CommentShape
ConditionalFormattingCollection
ConditionalFormattingIcon
ConditionalFormattingIconCollection
ConditionalFormattingResult
ConditionalFormattingValue
ConditionalFormattingValueCollection
ConnectionParameter
ConnectionParameterCollection
ContentTypeProperty
ContentTypePropertyCollection
CopyOptions
CustomDocumentPropertyCollection
CustomFilter
CustomFilterCollection
CustomGeometry
CustomImplementationFactory
CustomProperty
CustomPropertyCollection
CustomXmlPart
CustomXmlPartCollection
CustomXmlShape
DataBar
DataBarBorder
DataLabels
DataSorter
DataSorterKey
DataSorterKeyCollection
DateTime
DateTimeGroupItem
DBConnection
DefaultStyleSettings
DeleteOptions
DialogBox
DifSaveOptions
DigitalSignature
DigitalSignatureCollection
DisplayUnitLabel
DocumentProperty
DocumentPropertyCollection
DocxSaveOptions
DrawObject
DrawObjectEventHandler
DropBars
DxfCollection
DynamicFilter
Encoding
ErrorBar
ErrorCheckOption
ErrorCheckOptionCollection
ExportObjectEvent
ExportRangeToJsonOptions
ExportTableOptions
ExternalConnection
ExternalConnectionCollection
ExternalLink
ExternalLinkCollection
FileFontSource
FileFormatInfo
FileFormatUtil
Fill
FillFormat
FilterColumn
FilterColumnCollection
FindOptions
Floor
FolderFontSource
Font
FontConfigs
FontSetting
FontSettingCollection
FontSourceBase
Format3D
FormatCondition
FormatConditionCollection
FormulaParseOptions
FormulaSettings
Geometry
GlobalizationSettings
GlowEffect
GradientFill
GradientStop
GradientStopCollection
GroupBox
GroupFill
GroupShape
HeaderFooterCommand
HorizontalPageBreak
HorizontalPageBreakCollection
HtmlLoadOptions
HtmlSaveOptions
Hyperlink
HyperlinkCollection
IconFilter
IconSet
ImageActiveXControl
ImageFormat
ImageOrPrintOptions
ImageSaveOptions
ImportTableOptions
IndividualFontConfigs
InsertOptions
InterruptMonitor
JsonLayoutOptions
JsonLoadOptions
JsonSaveOptions
JsonUtility
Label
LabelActiveXControl
Legend
LegendEntry
LegendEntryCollection
License
Line
LineFormat
LineShape
ListBox
ListBoxActiveXControl
ListColumn
ListColumnCollection
ListObject
ListObjectCollection
LoadFilter
LoadOptions
MarkdownSaveOptions
Marker
MemoryFontSource
MetadataOptions
Metered
MsoFillFormat
MsoFillFormatHelper
MsoFormatPicture
MsoLineFormat
MsoLineFormatHelper
MsoTextFrame
MultipleFilterCollection
Name
NameCollection
NegativeBarFormat
NoneBulletValue
NoneFill
OdsCellField
OdsCellFieldCollection
OdsLoadOptions
OdsPageBackground
OdsSaveOptions
OleObject
OleObjectCollection
OoxmlSaveOptions
Outline
Oval
PageEndSavingArgs
PageSavingArgs
PageSetup
PageStartSavingArgs
PaginatedSaveOptions
PaneCollection
PasteOptions
PatternFill
PdfBookmarkEntry
PdfSaveOptions
PdfSecurityOptions
PicFormatOption
Picture
PictureBulletValue
PictureCollection
PivotField
PivotFieldCollection
PivotFilter
PivotFilterCollection
PivotFormatCondition
PivotFormatConditionCollection
PivotItem
PivotItemCollection
PivotOptions
PivotPageFields
PivotTable
PivotTableCollection
PlotArea
PptxSaveOptions
ProtectedRange
ProtectedRangeCollection
Protection
QueryTable
QueryTableCollection
RadioButton
RadioButtonActiveXControl
Range
RangeCollection
RectangleShape
ReferredArea
ReferredAreaCollection
ReflectionEffect
ReplaceOptions
Revision
RevisionAutoFormat
RevisionCellChange
RevisionCellComment
RevisionCellMove
RevisionCollection
RevisionCustomView
RevisionDefinedName
RevisionFormat
RevisionInsertDelete
RevisionInsertSheet
RevisionLog
RevisionLogCollection
RevisionMergeConflict
RevisionQueryTable
RevisionRenameSheet
Row
RowCollection
SaveOptions
Scenario
ScenarioCollection
ScenarioInputCell
ScenarioInputCellCollection
ScrollBar
ScrollBarActiveXControl
Series
SeriesCollection
SeriesLayoutProperties
ShadowEffect
Shape
ShapeCollection
ShapeFormat
ShapeGuide
ShapeGuideCollection
ShapePath
ShapePathCollection
ShapePathPoint
ShapePathPointCollection
ShapePropertyCollection
ShapeSegmentPath
ShapeSegmentPathCollection
ShapeTextAlignment
SheetPrintingPreview
SheetRender
SheetSet
SignatureLine
Slicer
SlicerCache
SlicerCacheItem
SlicerCacheItemCollection
SlicerCollection
SmartArtShape
SmartTag
SmartTagCollection
SmartTagOptions
SmartTagProperty
SmartTagPropertyCollection
SmartTagSetting
SolidFill
Sparkline
SparklineCollection
SparklineGroup
SparklineGroupCollection
SpinButtonActiveXControl
Spinner
SpreadsheetML2003SaveOptions
StreamProviderOptions
Style
StyleFlag
SubtotalSetting
SvgSaveOptions
SxRng
TableStyle
TableStyleCollection
TableStyleElement
TableStyleElementCollection
TableToRangeOptions
TextBox
TextBoxActiveXControl
TextBoxCollection
TextEffectFormat
TextOptions
TextParagraph
TextParagraphCollection
TextTabStop
TextTabStopCollection
TextureFill
ThemeColor
ThreadedComment
ThreadedCommentAuthor
ThreadedCommentAuthorCollection
ThreadedCommentCollection
ThreeDFormat
TickLabelItem
TickLabels
TilePicOption
Timeline
TimelineCollection
Title
ToggleButtonActiveXControl
Top10
Top10Filter
Trendline
TrendlineCollection
TxtLoadOptions
TxtSaveOptions
UnionRange
UnknownControl
Validation
ValidationCollection
VbaModule
VbaModuleCollection
VbaProject
VbaProjectReference
VbaProjectReferenceCollection
VerticalPageBreak
VerticalPageBreakCollection
VmlShapeGuide
Walls
WarningInfo
WebExtension
WebExtensionBinding
WebExtensionBindingCollection
WebExtensionCollection
WebExtensionProperty
WebExtensionPropertyCollection
WebExtensionReference
WebExtensionReferenceCollection
WebExtensionShape
WebExtensionTaskPane
WebExtensionTaskPaneCollection
WebQueryConnection
Workbook
WorkbookDesigner
WorkbookMetadata
WorkbookPrintingPreview
WorkbookRender
WorkbookSettings
Worksheet
WorksheetCollection
WriteProtection
XlsbSaveOptions
XlsSaveOptions
XmlColumnProperty
XmlDataBinding
XmlLoadOptions
XmlMap
XmlMapCollection
XmlSaveOptions
XpsSaveOptions
Interfaces 
ICellsDataTable
ICustomFunction
ICustomParser
IExportObjectListener
IFilePathProvider
IPageSavingCallback
ISmartMarkerCallBack
IStreamProvider
IWarningCallback
LightCellsDataHandler
LightCellsDataProvider
Constants 
AccessCacheOptions
ActiveXPersistenceType
AutoFillType
AutoFitMergedCellsType
AutoFitWrappedTextType
AutoShapeType
AxisType
BackgroundMode
BackgroundType
Bar3DShapeType
BevelPresetType
BevelType
BorderType
BubbleSizeRepresents
BuiltinStyleType
BulletType
CalcModeType
CalculationPrecisionStrategy
CategoryType
CellBorderType
CellValueFormatStrategy
CellValueType
ChartLineFormattingType
ChartMarkerType
ChartSplitType
ChartTextDirectionType
ChartType
CheckValueType
ColorDepth
ColorType
CommentTitleType
ConnectionDataSourceType
ConnectionParameterType
ConsolidationFunction
ControlBorderType
ControlCaptionAlignmentType
ControlListStyle
ControlMatchEntryType
ControlMousePointerType
ControlPictureAlignmentType
ControlPicturePositionType
ControlPictureSizeMode
ControlScrollBarType
ControlScrollOrientation
ControlSpecialEffectType
ControlType
CopyFormatType
CountryCode
CredentialsMethodType
CrossType
DataBarAxisPosition
DataBarBorderType
DataBarFillType
DataBarNegativeColorType
DataLabelShapeType
DataLabelsSeparatorType
DataLablesSeparatorType
DateTimeGroupingType
DefaultEditLanguage
DirectoryType
DisplayDrawingObjects
DisplayUnitType
DrawObjectEnum
DropButtonStyle
DynamicFilterType
EmfRenderSetting
EncryptionType
ErrorBarDisplayType
ErrorBarType
ErrorCheckType
ExceptionType
ExternalLinkType
FileFormatType
FillPattern
FillPictureType
FillType
FilterOperatorType
FilterType
FontSchemeType
FontSourceType
FontUnderlineType
FormatConditionType
FormatConditionValueType
FormatSetType
FormattingType
GradientColorType
GradientDirectionType
GradientFillType
GradientPresetType
GradientStyleType
GridlineType
HeaderFooterCommandType
HtmlCrossType
HtmlExportDataOptions
HtmlFormatHandlingType
HtmlHiddenColDisplayType
HtmlHiddenRowDisplayType
HtmlLinkTargetType
IconSetType
ImageType
InputMethodEditorMode
LabelPositionType
LegendPositionType
LightRigDirectionType
LightRigType
LineCapType
LineJoinType
LineSpaceSizeType
LineType
LoadDataFilterOptions
LoadFormat
LookAtType
LookInType
MapChartLabelLayout
MapChartProjectionType
MapChartRegionType
MemorySetting
MetadataType
MirrorType
MsoArrowheadLength
MsoArrowheadStyle
MsoArrowheadWidth
MsoDrawingType
MsoLineDashStyle
MsoLineStyle
MsoPresetTextEffect
MsoPresetTextEffectShape
NameScopeType
NumberCategoryType
OdsCellFieldType
OdsGeneratorType
OdsPageBackgroundGraphicPositionType
OdsPageBackgroundGraphicType
OdsPageBackgroundType
OLEDBCommandType
OoxmlCompliance
OoxmlCompressionType
OperatorType
PageLayoutAlignmentType
PageOrientationType
PaneStateType
PaperSizeType
ParameterType
PasteOperationType
PasteType
PdfCompliance
PdfCompressionCore
PdfCustomPropertiesExport
PdfFontEncoding
PdfOptimizationType
PivotConditionFormatRuleType
PivotConditionFormatScopeType
PivotFieldDataDisplayFormat
PivotFieldSubtotalType
PivotFieldType
PivotFilterType
PivotGroupByType
PivotItemPosition
PivotMissingItemLimitType
PivotTableAutoFormatType
PivotTableStyleType
PlacementType
PlotDataByType
PlotEmptyCellsType
PresetCameraType
PresetMaterialType
PresetShadowType
PresetWordArtStyle
PrintCommentsType
PrintErrorsType
PrintingPageType
PrintOrderType
PrintSizeType
PropertyType
ProtectionType
QuartileCalculationType
ReConnectionMethodType
RectangleAlignmentType
ReflectionEffectType
RenameStrategy
ResourceLoadingType
RevisionActionType
RevisionType
SaveFormat
SelectionType
ShapeAnchorType
ShapeLockType
ShapePathType
SheetType
ShiftType
ShowDropButtonType
SlicerCacheCrossFilterType
SlicerCacheItemSortType
SlicerStyleType
SmartTagShowType
SortOnType
SortOrder
SparklineAxisMinMaxType
SparklinePresetStyleType
SparklineType
SqlDataType
StyleModifyFlag
TableDataSourceType
TableStyleElementType
TableStyleType
TargetModeType
TextAlignmentType
TextAutonumberScheme
TextCapsType
TextCrossType
TextDirectionType
TextFontAlignType
TextNodeType
TextOrientationType
TextOverflowType
TextStrikeType
TextTabAlignmentType
TextureType
TextVerticalType
ThemeColorType
TickLabelPositionType
TickMarkType
TiffCompression
TimePeriodType
TimeUnit
TotalsCalculation
TrendlineType
TxtLoadStyleStrategy
TxtValueQuoteType
UpdateLinksType
ValidationAlertType
ValidationType
VbaModuleType
VbaProjectReferenceType
ViewType
VisibilityType
WarningType
WebExtensionStoreType
WeightType
XAdESType

com.aspose.cells
Class ChartShape

java.lang.Object
  extended by Shape
      extended by com.aspose.cells.ChartShape

public class ChartShape 
extends Shape

Represents the shape of the chart. Properties and methods for the ChartObject object control the appearance and size of the embedded chart on the worksheet.

Example:

//Instantiating a Workbook object
Workbook workbook = new Workbook();

//Obtaining the reference of the first worksheet
Worksheet worksheet = workbook.getWorksheets().get(0);

//Adding a sample value to "A1" cell
worksheet.getCells().get("A1").putValue(50);

//Adding a sample value to "A2" cell
worksheet.getCells().get("A2").putValue(100);

//Adding a sample value to "A3" cell
worksheet.getCells().get("A3").putValue(150);

//Adding a sample value to "B1" cell
worksheet.getCells().get("B1").putValue(60);

//Adding a sample value to "B2" cell
worksheet.getCells().get("B2").putValue(32);

//Adding a sample value to "B3" cell
worksheet.getCells().get("B3").putValue(50);

//Adding a chart to the worksheet
int chartIndex = worksheet.getCharts().add(ChartType.PIE_EXPLODED, 5, 0, 25, 10);

//Accessing the instance of the newly added chart
Chart chart = worksheet.getCharts().get(chartIndex);

//Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B3"
chart.getNSeries().add("A1:B3", true);

//Show Data Labels 
chart.getNSeries().get(0).getDataLabels().setShowValue(true);

//Getting Chart Shape
ChartShape chartShape = chart.getChartObject();

//Set Lower Right Column
chartShape.setLowerRightColumn(10);

//Set LowerDeltaX
chartShape.setLowerDeltaX(1024);

//Saving the Excel file
workbook.save("book1.xls");


Property Getters/Setters Summary
ActiveXControlgetActiveXControl()→ inherited from Shape
           Gets the ActiveX control.
intgetActualLowerRightRow()→ inherited from Shape
           Get the actual bottom row.
java.lang.StringgetAlternativeText()→ inherited from Shape
voidsetAlternativeText(java.lang.String)
           Returns or sets the descriptive (alternative) text string of the Shape object.
intgetAnchorType()→ inherited from Shape
voidsetAnchorType(int)
           Gets and set the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant.
intgetAutoShapeType()→ inherited from Shape
voidsetAutoShapeType(int)
           Gets and sets the auto shape type. The value of the property is AutoShapeType integer constant.
intgetBottom()→ inherited from Shape
voidsetBottom(int)
           Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.
ChartgetChart()
           Returns a Chart object that represents the chart contained in the object.
java.awt.geom.Point2D.Float[]getConnectionPoints()→ inherited from Shape
           Get the connection points
byte[]getControlData()→ inherited from Shape
           Gets the data of control.
java.util.UUIDgetCreateId()→ inherited from Shape
           Gets and sets create id for this shape.
FillFormatgetFill()→ inherited from Shape
           Returns a FillFormat object that contains fill formatting properties for the specified shape.
MsoFillFormatgetFillFormat()→ inherited from Shape
           Returns a MsoFillFormat object that contains fill formatting properties for the specified shape.
FontgetFont()→ inherited from Shape
voidsetFont(Font)
           Represents the font of shape.
ShapeFormatgetFormat()→ inherited from Shape
           Represents the setting of the shape's formatting.
MsoFormatPicturegetFormatPicture()→ inherited from Shape
           Gets and sets the options of the picture format.
GeometrygetGeometry()→ inherited from Shape
           Gets the geometry
GlowEffectgetGlow()→ inherited from Shape
           Represents a object that specifies glow effect for the chart element or shape.
GroupShapegetGroup()→ inherited from Shape
           Gets the group shape which contains this shape.
booleanhasLine()→ inherited from Shape
voidsetHasLine(boolean)
           Gets and sets the line border of the shape is visible.
intgetHeight()→ inherited from Shape
voidsetHeight(int)
           Represents the height of shape, in unit of pixel.
doublegetHeightCM()→ inherited from Shape
voidsetHeightCM(double)
           Represents the height of the shape, in unit of centimeters.
doublegetHeightInch()→ inherited from Shape
voidsetHeightInch(double)
           Represents the height of the shape, in unit of inches.
intgetHeightInChart()→ inherited from Shape
voidsetHeightInChart(int)
           Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
intgetHeightInShape()→ inherited from Shape
voidsetHeightInShape(int)
           Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape..
doublegetHeightPt()→ inherited from Shape
voidsetHeightPt(double)
           Represents the height of the shape, in unit of points.
intgetHeightScale()→ inherited from Shape
voidsetHeightScale(int)
           Gets and sets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the HeightScale property only returns 100;
java.lang.StringgetHtmlText()→ inherited from Shape
voidsetHtmlText(java.lang.String)
           Gets and sets the html string which contains data and some formats in this textbox.
HyperlinkgetHyperlink()→ inherited from Shape
           Gets the hyperlink of the shape.
intgetId()→ inherited from Shape
           Gets the identifier of this shape.
java.lang.StringgetInputRange()→ inherited from Shape
voidsetInputRange(java.lang.String)
           Gets or sets the worksheet range used to fill the specified combo box.
booleanisEquation()→ inherited from Shape
           Indicates whether the shape only contains an equation.
booleanisFilled()→ inherited from Shape
voidsetFilled(boolean)
           Indicates whether the fill format is visible.
booleanisFlippedHorizontally()→ inherited from Shape
voidsetFlippedHorizontally(boolean)
           Gets and sets whether shape is horizontally flipped .
booleanisFlippedVertically()→ inherited from Shape
voidsetFlippedVertically(boolean)
           Gets and sets whether shape is vertically flipped .
booleanisGroup()→ inherited from Shape
           Indicates whether the shape is a group.
booleanisHidden()→ inherited from Shape
voidsetHidden(boolean)
           Indicates whether the object is visible.
booleanisInGroup()→ inherited from Shape
           Indicates whether the shape is grouped.
booleanisLockAspectRatio()→ inherited from Shape
voidsetLockAspectRatio(boolean)
           True means that don't allow changes in aspect ratio.
booleanisLocked()→ inherited from Shape
voidsetLocked(boolean)
           True if the object is locked, False if the object can be modified when the sheet is protected.
booleanisPrintable()→ inherited from Shape
voidsetPrintable(boolean)
           True if the object is printable
booleanisRichText()→ inherited from Shape
           Whether or not the text is rich text.
booleanisSmartArt()→ inherited from Shape
           Indicates whether the shape is smart art.
booleanisTextWrapped()→ inherited from Shape
voidsetTextWrapped(boolean)
           Gets and sets the text wrapped type of the shape which contains text.
booleanisWordArt()→ inherited from Shape
           Indicates whether this shape is a word art.
intgetLeft()→ inherited from Shape
voidsetLeft(int)
           Represents the horizontal offset of shape from its left column, in unit of pixels.
doublegetLeftCM()→ inherited from Shape
voidsetLeftCM(double)
           Represents the horizontal offset of shape from its left column, in unit of centimeters.
doublegetLeftInch()→ inherited from Shape
voidsetLeftInch(double)
           Represents the horizontal offset of shape from its left column, in unit of inches.
intgetLeftInChart()→ inherited from Shape
voidsetLeftInChart(int)
           Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
intgetLeftInShape()→ inherited from Shape
voidsetLeftInShape(int)
           Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape.
intgetLeftToCorner()→ inherited from Shape
voidsetLeftToCorner(int)
           Gets and sets the horizonal offset of shape from worksheet left border.
LineFormatgetLine()→ inherited from Shape
           Gets line style
MsoLineFormatgetLineFormat()→ inherited from Shape
           Returns a MsoLineFormat object that contains line formatting properties for the specified shape.
java.lang.StringgetLinkedCell()→ inherited from Shape
voidsetLinkedCell(java.lang.String)
           Gets or sets the worksheet range linked to the control's value.
intgetLowerDeltaX()→ inherited from Shape
voidsetLowerDeltaX(int)
           Gets or sets the shape's horizontal offset from its lower right corner column.
intgetLowerDeltaY()→ inherited from Shape
voidsetLowerDeltaY(int)
           Gets or sets the shape's vertical offset from its lower right corner row.
intgetLowerRightColumn()→ inherited from Shape
voidsetLowerRightColumn(int)
           Represents lower right corner column index.
intgetLowerRightRow()→ inherited from Shape
voidsetLowerRightRow(int)
           Represents lower right corner row index.
java.lang.StringgetMacroName()→ inherited from Shape
voidsetMacroName(java.lang.String)
           Gets and sets the name of macro.
intgetMsoDrawingType()→ inherited from Shape
           Gets mso drawing type. The value of the property is MsoDrawingType integer constant.
java.lang.StringgetName()→ inherited from Shape
voidsetName(java.lang.String)
           Gets and sets the name of the shape.
ShapePathCollectiongetPaths()→ inherited from Shape
           Gets the paths of a custom geometric shape.
intgetPlacement()→ inherited from Shape
voidsetPlacement(int)
           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.
intgetPositionX()→ inherited from Shape
voidsetPositionX(int)
           Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels.
intgetPositionY()→ inherited from Shape
voidsetPositionY(int)
           Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
ReflectionEffectgetReflection()→ inherited from Shape
           Represents a object that specifies reflection effect for the chart element or shape.
booleangetRelativeToOriginalPictureSize()→ inherited from Shape
voidsetRelativeToOriginalPictureSize(boolean)
           Indicates whether shape is relative to original picture size.
intgetRight()→ inherited from Shape
voidsetRight(int)
           Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.
doublegetRotationAngle()→ inherited from Shape
voidsetRotationAngle(double)
           Gets and sets the rotation of the shape.
ShadowEffectgetShadowEffect()→ inherited from Shape
           Represents a object that specifies shadow effect for the chart element or shape.
doublegetSoftEdges()→ inherited from Shape
voidsetSoftEdges(double)
           Gets and sets the radius of blur to apply to the edges, in unit of points.
java.lang.StringgetSpid()→ inherited from Shape
           Specifies an optional string that an application can use to Identify the particular shape.
intgetSpt()→ inherited from Shape
           Specifies an optional number that an application can use to associate the particular shape with a defined shape type.
java.lang.StringgetText()→ inherited from Shape
voidsetText(java.lang.String)
           Represents the string in this TextBox object.
FontSettingCollectiongetTextBody()→ inherited from Shape
           Gets and sets the setting of the shape's text.
intgetTextDirection()→ inherited from Shape
voidsetTextDirection(int)
           Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constant.
TextEffectFormatgetTextEffect()→ inherited from Shape
           Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.
MsoTextFramegetTextFrame()→ inherited from Shape
           Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape.
intgetTextHorizontalAlignment()→ inherited from Shape
voidsetTextHorizontalAlignment(int)
           Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.
intgetTextHorizontalOverflow()→ inherited from Shape
voidsetTextHorizontalOverflow(int)
           Gets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.
TextOptionsgetTextOptions()→ inherited from Shape
voidsetTextOptions(TextOptions)
           Represents the text options of the shape.
intgetTextOrientationType()→ inherited from Shape
voidsetTextOrientationType(int)
           Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.
intgetTextShapeType()→ inherited from Shape
voidsetTextShapeType(int)
           Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.
intgetTextVerticalAlignment()→ inherited from Shape
voidsetTextVerticalAlignment(int)
           Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.
intgetTextVerticalOverflow()→ inherited from Shape
voidsetTextVerticalOverflow(int)
           Gets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.
ThreeDFormatgetThreeDFormat()→ inherited from Shape
           Gets and sets 3d format of the shape.
java.lang.StringgetTitle()→ inherited from Shape
voidsetTitle(java.lang.String)
           Specifies the title (caption) of the current shape object.
intgetTop()→ inherited from Shape
voidsetTop(int)
           Represents the vertical offset of shape from its top row, in unit of pixels.
doublegetTopCM()→ inherited from Shape
voidsetTopCM(double)
           Represents the vertical offset of shape from its top row, in unit of centimeters.
doublegetTopInch()→ inherited from Shape
voidsetTopInch(double)
           Represents the vertical offset of shape from its top row, in unit of inches.
intgetTopInChart()→ inherited from Shape
voidsetTopInChart(int)
           Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
intgetTopInShape()→ inherited from Shape
voidsetTopInShape(int)
           Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.
intgetTopToCorner()→ inherited from Shape
voidsetTopToCorner(int)
           Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.
intgetType()→ inherited from Shape
           Gets the auto shape type. The value of the property is AutoShapeType integer constant.
intgetUpperDeltaX()→ inherited from Shape
voidsetUpperDeltaX(int)
           Gets or sets the shape's horizontal offset from its upper left corner column.
intgetUpperDeltaY()→ inherited from Shape
voidsetUpperDeltaY(int)
           Gets or sets the shape's vertical offset from its upper left corner row.
intgetUpperLeftColumn()→ inherited from Shape
voidsetUpperLeftColumn(int)
           Represents upper left corner column index.
intgetUpperLeftRow()→ inherited from Shape
voidsetUpperLeftRow(int)
           Represents upper left corner row index.
intgetWidth()→ inherited from Shape
voidsetWidth(int)
           Represents the width of shape, in unit of pixels.
doublegetWidthCM()→ inherited from Shape
voidsetWidthCM(double)
           Represents the width of the shape, in unit of centimeters.
doublegetWidthInch()→ inherited from Shape
voidsetWidthInch(double)
           Represents the width of the shape, in unit of inch.
intgetWidthInChart()→ inherited from Shape
voidsetWidthInChart(int)
           Represents the width of the shape, in unit of 1/4000 of the parent shape.
intgetWidthInShape()→ inherited from Shape
voidsetWidthInShape(int)
           Represents the width of the shape, in unit of 1/4000 of the parent shape.
doublegetWidthPt()→ inherited from Shape
voidsetWidthPt(double)
           Represents the width of the shape, in unit of point.
intgetWidthScale()→ inherited from Shape
voidsetWidthScale(int)
           Gets and sets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthScale property only returns 100;
WorksheetgetWorksheet()→ inherited from Shape
           Gets the Worksheet object which contains this shape.
intgetX()→ inherited from Shape
voidsetX(int)
           Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.
intgetY()→ inherited from Shape
voidsetY(int)
           Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.
intgetZOrderPosition()→ inherited from Shape
voidsetZOrderPosition(int)
           Returns the position of a shape in the z-order.
 
Method Summary
HyperlinkaddHyperlink(java.lang.String address)→ inherited from Shape
           Adds a hyperlink to the shape.
voidalignTopRightCorner(int topRow, int rightColumn)→ inherited from Shape
           Moves the picture to the top-right corner.
int[]calculateTextSize()→ inherited from Shape
           Recalculate the text area
FontSettingcharacters(int startIndex, int length)→ inherited from Shape
           Returns a Characters object that represents a range of characters within the text.
voidformatCharacters(int startIndex, int length, Font font)→ inherited from Shape
           Formats some characters with the font setting.
voidformatCharacters(int startIndex, int length, Font font, StyleFlag flag)→ inherited from Shape
           Formats some characters with the font setting.
java.util.ArrayListgetCharacters()→ inherited from Shape
           Returns all Characters objects that represents a range of characters within the text .
float[][]getConnectionPoints()→ inherited from Shape
           Get the connection points
java.lang.StringgetInputRange(boolean isR1C1, boolean isLocal)→ inherited from Shape
           Gets the range used to fill the control.
java.lang.StringgetLinkedCell(boolean isR1C1, boolean isLocal)→ inherited from Shape
           Gets the range linked to the control's value.
booleangetLockedProperty(int type)→ inherited from Shape
           Gets the value of locked property.
GroupShapegetResultOfSmartArt()→ inherited from Shape
           Converting smart art to grouped shapes.
booleanisSameSetting(java.lang.Object obj)→ inherited from Shape
           Returns whether the shape is same.
voidmoveToRange(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn)→ inherited from Shape
           Moves the shape to a specified range.
voidremoveActiveXControl()→ inherited from Shape
           Remove activeX control.
voidremoveHyperlink()→ inherited from Shape
           Remove the hyperlink of the shape.
voidsetInputRange(java.lang.String formula, boolean isR1C1, boolean isLocal)→ inherited from Shape
           Sets the range used to fill the control.
voidsetLinkedCell(java.lang.String formula, boolean isR1C1, boolean isLocal)→ inherited from Shape
           Sets the range linked to the control's value.
voidsetLockedProperty(int type, boolean value)→ inherited from Shape
           Set the locked property.
voidtoFrontOrBack(int orders)→ inherited from Shape
           Brings the shape to the front or sends the shape to back.
voidtoImage(java.io.OutputStream stream, ImageFormat imageFormat)→ inherited from Shape
           Creates the shape image and saves it to a stream in the specified format.
voidtoImage(java.io.OutputStream stream, ImageOrPrintOptions options)→ inherited from Shape
           Saves the shape to a stream.
voidtoImage(java.lang.String imageFile, ImageOrPrintOptions options)→ inherited from Shape
           Saves the shape to a file.
voidupdateSelectedValue()→ inherited from Shape
           Update the selected value by the value of the linked cell.
 

Property Getters/Setters Detail

getChart

public Chart getChart()
Returns a Chart object that represents the chart contained in the object.

getMacroName/setMacroName

→ inherited from Shape
public java.lang.String getMacroName() / public void setMacroName(java.lang.String value)
Gets and sets the name of macro.

Example:

//Sets the name of macro.
shape.setMacroName("DoWork()");

isEquation

→ inherited from Shape
public boolean isEquation()
Indicates whether the shape only contains an equation.

Example:

//If true,the shape only contains an equation.
if(shape.isEquation())
{
    //The shape contains only an equation
}

isSmartArt

→ inherited from Shape
public boolean isSmartArt()
Indicates whether the shape is smart art. Only for ooxml file.

Example:

//if true,the shape is smart art.
if(shape.isSmartArt())
{
    //The shape is SmartArt object.
}

getZOrderPosition/setZOrderPosition

→ inherited from Shape
public int getZOrderPosition() / public void setZOrderPosition(int value)
Returns the position of a shape in the z-order.

Example:

shape.setZOrderPosition(3);

getName/setName

→ inherited from Shape
public java.lang.String getName() / public void setName(java.lang.String value)
Gets and sets the name of the shape.

Example:

shape.setName("shape1");

getAlternativeText/setAlternativeText

→ inherited from Shape
public java.lang.String getAlternativeText() / public void setAlternativeText(java.lang.String value)
Returns or sets the descriptive (alternative) text string of the Shape object.

Example:

shape.setAlternativeText("a rectangle");

getTitle/setTitle

→ inherited from Shape
public java.lang.String getTitle() / public void setTitle(java.lang.String value)
Specifies the title (caption) of the current shape object.

Example:

shape.setTitle("title1");

getLineFormat

→ inherited from Shape
public MsoLineFormat getLineFormat()
Returns a MsoLineFormat object that contains line formatting properties for the specified shape. NOTE: This member is now obsolete. Instead, please use Shape.Line property. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.

getFillFormat

→ inherited from Shape
public MsoFillFormat getFillFormat()
Returns a MsoFillFormat object that contains fill formatting properties for the specified shape. NOTE: This member is now obsolete. Instead, please use Shape.Fill property. This property will be removed 12 months later since July 2016. Aspose apologizes for any inconvenience you may have experienced.

getFormat

→ inherited from Shape
public ShapeFormat getFormat()
Represents the setting of the shape's formatting. NOTE: This member is now obsolete. Instead, please use Shape.Fill and Shape.Line properties. This property will be removed 6 months later since August 2016. Aspose apologizes for any inconvenience you may have experienced.

getLine

→ inherited from Shape
public LineFormat getLine()
Gets line style

Example:

LineFormat lineFmt = shape.getLine();

getFill

→ inherited from Shape
public FillFormat getFill()
Returns a FillFormat object that contains fill formatting properties for the specified shape.

Example:

FillFormat fillFmt = shape.getFill();

getShadowEffect

→ inherited from Shape
public ShadowEffect getShadowEffect()
Represents a object that specifies shadow effect for the chart element or shape.

Example:

ShadowEffect shadowEffect = shape.getShadowEffect();
See Also:
ShadowEffect

getReflection

→ inherited from Shape
public ReflectionEffect getReflection()
Represents a object that specifies reflection effect for the chart element or shape.

Example:

ReflectionEffect reflectionEffect = shape.getReflection();
See Also:
ReflectionEffect

getGlow

→ inherited from Shape
public GlowEffect getGlow()
Represents a object that specifies glow effect for the chart element or shape.

Example:

GlowEffect glowEffect = shape.getGlow();
See Also:
GlowEffect

getSoftEdges/setSoftEdges

→ inherited from Shape
public double getSoftEdges() / public void setSoftEdges(double value)
Gets and sets the radius of blur to apply to the edges, in unit of points.

Example:

shape.setSoftEdges(0.5d);

getThreeDFormat

→ inherited from Shape
public ThreeDFormat getThreeDFormat()
Gets and sets 3d format of the shape.

Example:

ThreeDFormat threeDFormat = shape.getThreeDFormat();

getTextFrame

→ inherited from Shape
public MsoTextFrame getTextFrame()
Returns a TextFrame object that contains the alignment and anchoring properties for the specified shape. NOTE: This member is now obsolete. Instead, please use Shape.TextBody.TextAlignment property. This property will be removed 12 months later since May 2016. Aspose apologizes for any inconvenience you may have experienced.

getFormatPicture

→ inherited from Shape
public MsoFormatPicture getFormatPicture()
Gets and sets the options of the picture format.

Example:

MsoFormatPicture msoFormatPicture = shape.getFormatPicture();

isHidden/setHidden

→ inherited from Shape
public boolean isHidden() / public void setHidden(boolean value)
Indicates whether the object is visible.

Example:

shape.setHidden(false);

isLockAspectRatio/setLockAspectRatio

→ inherited from Shape
public boolean isLockAspectRatio() / public void setLockAspectRatio(boolean value)
True means that don't allow changes in aspect ratio.

Example:

shape.setLockAspectRatio(false);

getRotationAngle/setRotationAngle

→ inherited from Shape
public double getRotationAngle() / public void setRotationAngle(double value)
Gets and sets the rotation of the shape.

Example:

if(shape.getRotationAngle() == 45)
    shape.setRotationAngle(60);

getHyperlink

→ inherited from Shape
public Hyperlink getHyperlink()
Gets the hyperlink of the shape.

Example:

Hyperlink hyperlink = shape.getHyperlink();

getId

→ inherited from Shape
public int getId()
Gets the identifier of this shape.

Example:

int id = shape.getId();

getSpid

→ inherited from Shape
public java.lang.String getSpid()
Specifies an optional string that an application can use to Identify the particular shape.

Example:

String spid = shape.getSpid();

getSpt

→ inherited from Shape
public int getSpt()
Specifies an optional number that an application can use to associate the particular shape with a defined shape type.

Example:

int spt = shape.getSpt();

getWorksheet

→ inherited from Shape
public Worksheet getWorksheet()
Gets the Worksheet object which contains this shape.

Example:

Worksheet worksheet = shape.getWorksheet();

isGroup

→ inherited from Shape
public boolean isGroup()
Indicates whether the shape is a group.

Example:

if(shape.isGroup())
{
    //This shape is a group.
}

isInGroup

→ inherited from Shape
public boolean isInGroup()
Indicates whether the shape is grouped.

isWordArt

→ inherited from Shape
public boolean isWordArt()
Indicates whether this shape is a word art. Only for the Legacy Shape of xls file.

Example:

if(shape.isWordArt())
{
    //This shape is a WordArt object.
}

getTextEffect

→ inherited from Shape
public TextEffectFormat getTextEffect()
Returns a TextEffectFormat object that contains text-effect formatting properties for the specified shape. Applies to Shape objects that represent WordArt.

Example:

TextEffectFormat textEffectFormat = shape.getTextEffect();

isLocked/setLocked

→ inherited from Shape
public boolean isLocked() / public void setLocked(boolean value)
True if the object is locked, False if the object can be modified when the sheet is protected.

Example:

if(shape.isLocked())
    shape.setLocked(false);

isPrintable/setPrintable

→ inherited from Shape
public boolean isPrintable() / public void setPrintable(boolean value)
True if the object is printable

Example:

if(shape.isPrintable())
    shape.setPrintable(false);

getMsoDrawingType

→ inherited from Shape
public int getMsoDrawingType()
Gets mso drawing type. The value of the property is MsoDrawingType integer constant.

Example:

/*Aspose.Cells.Drawing.MsoDrawingType*/int msoDrawingType = shape.getMsoDrawingType();

getAutoShapeType/setAutoShapeType

→ inherited from Shape
public int getAutoShapeType() / public void setAutoShapeType(int value)
Gets and sets the auto shape type. The value of the property is AutoShapeType integer constant.

Example:

if (shape.getAutoShapeType() == com.aspose.cells.AutoShapeType.UNKNOWN)
    shape.setAutoShapeType(com.aspose.cells.AutoShapeType.RECTANGLE);

getAnchorType/setAnchorType

→ inherited from Shape
public int getAnchorType() / public void setAnchorType(int value)
Gets and set the shape anchor placeholder. The value of the property is ShapeAnchorType integer constant.

Example:

if (shape.getAnchorType() == ShapeAnchorType.ONE_CELL_ANCHOR)
    shape.setAnchorType(ShapeAnchorType.TWO_CELL_ANCHOR);

getPlacement/setPlacement

→ inherited from Shape
public int getPlacement() / public void setPlacement(int 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.

Example:

if (shape.getPlacement() == PlacementType.MOVE)
    shape.setPlacement(PlacementType.MOVE_AND_SIZE);

getUpperLeftRow/setUpperLeftRow

→ inherited from Shape
public int getUpperLeftRow() / public void setUpperLeftRow(int value)
Represents upper left corner row index. If the shape is in the shape or in the group , UpperLeftRow will be ignored.

Example:

if (shape.getUpperLeftRow() == 3)
    shape.setUpperLeftRow(1);

getUpperDeltaY/setUpperDeltaY

→ inherited from Shape
public int getUpperDeltaY() / public void setUpperDeltaY(int value)
Gets or sets the shape's vertical offset from its upper left corner row. The range of value is 0 to 256.

Example:

if (shape.getUpperDeltaY() == 3)
    shape.setUpperDeltaY(1);

getUpperLeftColumn/setUpperLeftColumn

→ inherited from Shape
public int getUpperLeftColumn() / public void setUpperLeftColumn(int value)
Represents upper left corner column index.

Example:

if (shape.getUpperLeftColumn() == 3)
    shape.setUpperLeftColumn(1);

getUpperDeltaX/setUpperDeltaX

→ inherited from Shape
public int getUpperDeltaX() / public void setUpperDeltaX(int value)
Gets or sets the shape's horizontal offset from its upper left corner column. The range of value is 0 to 1024.

Example:

if (shape.getUpperDeltaX() == 3)
    shape.setUpperDeltaX(1);

getLowerRightRow/setLowerRightRow

→ inherited from Shape
public int getLowerRightRow() / public void setLowerRightRow(int value)
Represents lower right corner row index.

Example:

if (shape.getLowerRightRow() == 3)
    shape.setLowerRightRow(1);

getLowerDeltaY/setLowerDeltaY

→ inherited from Shape
public int getLowerDeltaY() / public void setLowerDeltaY(int value)
Gets or sets the shape's vertical offset from its lower right corner row. The range of value is 0 to 256.

Example:

if (shape.getLowerDeltaY() == 3)
    shape.setLowerDeltaY(1);

getLowerRightColumn/setLowerRightColumn

→ inherited from Shape
public int getLowerRightColumn() / public void setLowerRightColumn(int value)
Represents lower right corner column index.

Example:

if (shape.getLowerRightColumn() == 3)
    shape.setLowerRightColumn(1);

getLowerDeltaX/setLowerDeltaX

→ inherited from Shape
public int getLowerDeltaX() / public void setLowerDeltaX(int value)
Gets or sets the shape's horizontal offset from its lower right corner column. The range of value is 0 to 1024.

Example:

if (shape.getLowerDeltaX() == 3)
    shape.setLowerDeltaX(1);

getRight/setRight

→ inherited from Shape
public int getRight() / public void setRight(int value)
Represents the width of the shape's horizontal offset from its lower right corner column, in unit of pixels.

Example:

if (shape.getRight() == 3)
    shape.setRight(1);

getBottom/setBottom

→ inherited from Shape
public int getBottom() / public void setBottom(int value)
Represents the width of the shape's vertical offset from its lower bottom corner row, in unit of pixels.

Example:

if (shape.getBottom() == 3)
    shape.setBottom(1);

getWidth/setWidth

→ inherited from Shape
public int getWidth() / public void setWidth(int value)
Represents the width of shape, in unit of pixels.

Example:

if (shape.getWidth() == 3)
    shape.setWidth(1);

getWidthInch/setWidthInch

→ inherited from Shape
public double getWidthInch() / public void setWidthInch(double value)
Represents the width of the shape, in unit of inch.

Example:

if (shape.getWidthInch() == 3)
    shape.setWidthInch(1);

getWidthPt/setWidthPt

→ inherited from Shape
public double getWidthPt() / public void setWidthPt(double value)
Represents the width of the shape, in unit of point.

Example:

if (shape.getWidthPt() == 3)
    shape.setWidthPt(1);

getWidthCM/setWidthCM

→ inherited from Shape
public double getWidthCM() / public void setWidthCM(double value)
Represents the width of the shape, in unit of centimeters.

Example:

if (shape.getWidthCM() == 3)
    shape.setWidthCM(1);

getHeight/setHeight

→ inherited from Shape
public int getHeight() / public void setHeight(int value)
Represents the height of shape, in unit of pixel.

Example:

if (shape.getHeight() == 3)
    shape.setHeight(1);

getHeightInch/setHeightInch

→ inherited from Shape
public double getHeightInch() / public void setHeightInch(double value)
Represents the height of the shape, in unit of inches.

Example:

if (shape.getHeightInch() == 3)
    shape.setHeightInch(1);

getHeightPt/setHeightPt

→ inherited from Shape
public double getHeightPt() / public void setHeightPt(double value)
Represents the height of the shape, in unit of points.

Example:

if (shape.getHeightPt() == 3)
    shape.setHeightPt(1);

getHeightCM/setHeightCM

→ inherited from Shape
public double getHeightCM() / public void setHeightCM(double value)
Represents the height of the shape, in unit of centimeters.

Example:

if (shape.getHeightCM() == 3)
    shape.setHeightCM(1);

getLeft/setLeft

→ inherited from Shape
public int getLeft() / public void setLeft(int value)
Represents the horizontal offset of shape from its left column, in unit of pixels.

Example:

if (shape.getLeft() == 3)
    shape.setLeft(1);

getLeftInch/setLeftInch

→ inherited from Shape
public double getLeftInch() / public void setLeftInch(double value)
Represents the horizontal offset of shape from its left column, in unit of inches.

Example:

if (shape.getLeftInch() == 3)
    shape.setLeftInch(1);

getLeftCM/setLeftCM

→ inherited from Shape
public double getLeftCM() / public void setLeftCM(double value)
Represents the horizontal offset of shape from its left column, in unit of centimeters.

Example:

if (shape.getLeftCM() == 3)
    shape.setLeftCM(1);

getTop/setTop

→ inherited from Shape
public int getTop() / public void setTop(int value)
Represents the vertical offset of shape from its top row, in unit of pixels. If the shape is in the chart, represents the vertical offset of shape from its top border.

Example:

if (shape.getTop() == 3)
    shape.setTop(1);

getTopInch/setTopInch

→ inherited from Shape
public double getTopInch() / public void setTopInch(double value)
Represents the vertical offset of shape from its top row, in unit of inches.

Example:

if (shape.getTopInch() == 3)
    shape.setTopInch(1);

getTopCM/setTopCM

→ inherited from Shape
public double getTopCM() / public void setTopCM(double value)
Represents the vertical offset of shape from its top row, in unit of centimeters.

Example:

if (shape.getTopCM() == 3)
    shape.setTopCM(1);

getTopToCorner/setTopToCorner

→ inherited from Shape
public int getTopToCorner() / public void setTopToCorner(int value)
Gets and sets the vertical offset of shape from worksheet top border, in unit of pixels.

Example:

if (shape.getTopToCorner() == 3)
    shape.setTopToCorner(1);

getLeftToCorner/setLeftToCorner

→ inherited from Shape
public int getLeftToCorner() / public void setLeftToCorner(int value)
Gets and sets the horizonal offset of shape from worksheet left border.

Example:

if (shape.getLeftToCorner() == 3)
    shape.setLeftToCorner(1);

getX/setX

→ inherited from Shape
public int getX() / public void setX(int value)
Gets and sets the horizontal offset of shape from worksheet left border,in unit of pixels.

Example:

if (shape.getX() == 3)
    shape.setX(1);

getY/setY

→ inherited from Shape
public int getY() / public void setY(int value)
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels.

Example:

if (shape.getY() == 3)
    shape.setY(1);

getWidthScale/setWidthScale

→ inherited from Shape
public int getWidthScale() / public void setWidthScale(int value)
Gets and sets the width scale, in unit of percent of the original picture width. If the shape is not picture ,the WidthScale property only returns 100;

Example:

if (shape.getWidthScale() == 3)
    shape.setWidthScale(1);

getHeightScale/setHeightScale

→ inherited from Shape
public int getHeightScale() / public void setHeightScale(int value)
Gets and sets the height scale,in unit of percent of the original picture height. If the shape is not picture ,the HeightScale property only returns 100;

Example:

if (shape.getHeightScale() == 3)
    shape.setHeightScale(1);

getTopInShape/setTopInShape

→ inherited from Shape
public int getTopInShape() / public void setTopInShape(int value)
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape. Only Applies when this shape in the group or chart.

Example:

if (shape.getTopInShape() == 8000)
    shape.setTopInShape(4000);

getLeftInShape/setLeftInShape

→ inherited from Shape
public int getLeftInShape() / public void setLeftInShape(int value)
Represents the horizontal offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape. Only Applies when this shape in the group or chart.

Example:

if (shape.getUpperDeltaY() == 2000)
    shape.setUpperDeltaY(4000);

getWidthInShape/setWidthInShape

→ inherited from Shape
public int getWidthInShape() / public void setWidthInShape(int value)
Represents the width of the shape, in unit of 1/4000 of the parent shape. Only Applies when this shape in the group or chart.

Example:

if (shape.getUpperDeltaY() == 2000)
    shape.setUpperDeltaY(4000);

getHeightInShape/setHeightInShape

→ inherited from Shape
public int getHeightInShape() / public void setHeightInShape(int value)
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.. Only Applies when this shape in the group or chart.

Example:

if (shape.getUpperDeltaY() == 4000)
    shape.setUpperDeltaY(2000);

getHeightInChart/setHeightInChart

→ inherited from Shape
public int getHeightInChart() / public void setHeightInChart(int value)
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape.. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.HeightInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getLeftInChart/setLeftInChart

→ inherited from Shape
public int getLeftInChart() / public void setLeftInChart(int value)
Represents the vertical offset of shape from the left border of the parent shape, in unit of 1/4000 of width of the parent shape. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.LeftInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getTopInChart/setTopInChart

→ inherited from Shape
public int getTopInChart() / public void setTopInChart(int value)
Represents the vertical offset of shape from the top border of the parent shape, in unit of 1/4000 of height of the parent shape. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.TopInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getWidthInChart/setWidthInChart

→ inherited from Shape
public int getWidthInChart() / public void setWidthInChart(int value)
Represents the width of the shape, in unit of 1/4000 of the parent shape. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.WidthInShape property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getPositionX/setPositionX

→ inherited from Shape
public int getPositionX() / public void setPositionX(int value)
Gets and sets the horizonal offset of shape from worksheet left border,in unit of pixels. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.X property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getPositionY/setPositionY

→ inherited from Shape
public int getPositionY() / public void setPositionY(int value)
Gets and sets the vertical offset of shape from worksheet top border,in unit of pixels. NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Drawing.Shape.Y property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

getGroup

→ inherited from Shape
public GroupShape getGroup()
Gets the group shape which contains this shape.

Example:

GroupShape groupShape = shape.getGroup();

getType

→ inherited from Shape
public int getType()
Gets the auto shape type. The value of the property is AutoShapeType integer constant.

Example:

/*Aspose.Cells.Drawing.AutoShapeType*/int autoShapeType = shape.getType();

hasLine/setHasLine

→ inherited from Shape
public boolean hasLine() / public void setHasLine(boolean value)
Gets and sets the line border of the shape is visible.

Example:

if(shape.hasLine() == false)
    shape.setHasLine(true);

isFilled/setFilled

→ inherited from Shape
public boolean isFilled() / public void setFilled(boolean value)
Indicates whether the fill format is visible.

Example:

if(shape.isFilled() == false)
    shape.setFilled(true);

isFlippedHorizontally/setFlippedHorizontally

→ inherited from Shape
public boolean isFlippedHorizontally() / public void setFlippedHorizontally(boolean value)
Gets and sets whether shape is horizontally flipped .

Example:

if(shape.isFlippedHorizontally() == false)
    shape.setFlippedHorizontally(true);

isFlippedVertically/setFlippedVertically

→ inherited from Shape
public boolean isFlippedVertically() / public void setFlippedVertically(boolean value)
Gets and sets whether shape is vertically flipped .

Example:

if(shape.isFlippedVertically() == false)
    shape.setFlippedVertically(true);

getActualLowerRightRow

→ inherited from Shape
public int getActualLowerRightRow()
Get the actual bottom row.

Example:

int rRow = shape.getActualLowerRightRow();

getConnectionPoints

→ inherited from Shape
public java.awt.geom.Point2D.Float[] getConnectionPoints()
Get the connection points NOTE: This member is now obsolete. Instead, please use GetConnectionPoints() method. This method will be removed 12 months later since April 2022. Aspose apologizes for any inconvenience you may have experienced.

getRelativeToOriginalPictureSize/setRelativeToOriginalPictureSize

→ inherited from Shape
public boolean getRelativeToOriginalPictureSize() / public void setRelativeToOriginalPictureSize(boolean value)
Indicates whether shape is relative to original picture size.

Example:

if(shape.getRelativeToOriginalPictureSize())
    shape.setRelativeToOriginalPictureSize(false);

getLinkedCell/setLinkedCell

→ inherited from Shape
public java.lang.String getLinkedCell() / public void setLinkedCell(java.lang.String value)
Gets or sets the worksheet range linked to the control's value.

Example:

if (shape.getLinkedCell().equals("$B$6"))
    shape.setLinkedCell("A1");

getInputRange/setInputRange

→ inherited from Shape
public java.lang.String getInputRange() / public void setInputRange(java.lang.String value)
Gets or sets the worksheet range used to fill the specified combo box.

Example:

if (shape.getInputRange().equals("$B$6:$B10"))
    shape.setInputRange("$A$1:$A$5");

getTextShapeType/setTextShapeType

→ inherited from Shape
public int getTextShapeType() / public void setTextShapeType(int value)
Gets and sets the preset text shape type. The value of the property is AutoShapeType integer constant.

Example:

if (shape.getTextShapeType() == com.aspose.cells.AutoShapeType.UNKNOWN)
    shape.setTextShapeType(com.aspose.cells.AutoShapeType.RECTANGLE);

getTextBody

→ inherited from Shape
public FontSettingCollection getTextBody()
Gets and sets the setting of the shape's text.

Example:

FontSettingCollection fontSettingCollection = shape.getTextBody();
fontSettingCollection.setText("This is a test.");

getFont/setFont

→ inherited from Shape
public Font getFont() / public void setFont(Font value)
Represents the font of shape.

Example:

Font font = shape.getFont();
font.setName("Arial");
font.setSize(12);
font.setColor(Color.getRed());

getTextOptions/setTextOptions

→ inherited from Shape
public TextOptions getTextOptions() / public void setTextOptions(TextOptions value)
Represents the text options of the shape.

Example:

TextOptions opt = shape.getTextOptions();
opt.setColor(Color.getBlue());
opt.setSize(8);

getText/setText

→ inherited from Shape
public java.lang.String getText() / public void setText(java.lang.String value)
Represents the string in this TextBox object.

Example:

if(shape.getText() == null)
    shape.setText("This is a test.");

isRichText

→ inherited from Shape
public boolean isRichText()
Whether or not the text is rich text.

Example:

if(shape.isRichText())
    System.out.println("The text is rich text.");

getHtmlText/setHtmlText

→ inherited from Shape
public java.lang.String getHtmlText() / public void setHtmlText(java.lang.String value)
Gets and sets the html string which contains data and some formats in this textbox.

Example:

String html = shape.getHtmlText();
if(html == null || "".equals(html))
{
    shape.setHtmlText("<Font Style='FONT-FAMILY: Calibri;FONT-SIZE: 11pt;COLOR: #0000ff;TEXT-ALIGN: left;'>This is a <b>test</b>.</Font>");
}

getTextVerticalOverflow/setTextVerticalOverflow

→ inherited from Shape
public int getTextVerticalOverflow() / public void setTextVerticalOverflow(int value)
Gets and sets the text vertical overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.

Example:

if (shape.getTextVerticalOverflow() == com.aspose.cells.TextOverflowType.CLIP)
    shape.setTextVerticalOverflow(com.aspose.cells.TextOverflowType.OVERFLOW);

getTextHorizontalOverflow/setTextHorizontalOverflow

→ inherited from Shape
public int getTextHorizontalOverflow() / public void setTextHorizontalOverflow(int value)
Gets and sets the text horizontal overflow type of the shape which contains text. The value of the property is TextOverflowType integer constant.

Example:

if (shape.getTextHorizontalOverflow() == com.aspose.cells.TextOverflowType.CLIP)
    shape.setTextHorizontalOverflow(com.aspose.cells.TextOverflowType.OVERFLOW);

isTextWrapped/setTextWrapped

→ inherited from Shape
public boolean isTextWrapped() / public void setTextWrapped(boolean value)
Gets and sets the text wrapped type of the shape which contains text.

Example:

if (shape.isTextWrapped())
    shape.setTextWrapped(!shape.isTextWrapped());

getTextOrientationType/setTextOrientationType

→ inherited from Shape
public int getTextOrientationType() / public void setTextOrientationType(int value)
Gets and sets the text orientation type of the shape. The value of the property is TextOrientationType integer constant.

Example:

if (shape.getTextOrientationType() == com.aspose.cells.TextOrientationType.NO_ROTATION)
    shape.setTextOrientationType(com.aspose.cells.TextOrientationType.TOP_TO_BOTTOM);

getTextHorizontalAlignment/setTextHorizontalAlignment

→ inherited from Shape
public int getTextHorizontalAlignment() / public void setTextHorizontalAlignment(int value)
Gets and sets the text horizontal alignment type of the shape. The value of the property is TextAlignmentType integer constant.

Example:

if (shape.getTextHorizontalAlignment() == com.aspose.cells.TextAlignmentType.BOTTOM)
    shape.setTextHorizontalAlignment(com.aspose.cells.TextAlignmentType.CENTER);

getTextVerticalAlignment/setTextVerticalAlignment

→ inherited from Shape
public int getTextVerticalAlignment() / public void setTextVerticalAlignment(int value)
Gets and sets the text vertical alignment type of the shape. The value of the property is TextAlignmentType integer constant.

Example:

if (shape.getTextVerticalAlignment() == com.aspose.cells.TextAlignmentType.BOTTOM)
    shape.setTextVerticalAlignment(com.aspose.cells.TextAlignmentType.CENTER);

getTextDirection/setTextDirection

→ inherited from Shape
public int getTextDirection() / public void setTextDirection(int value)
Gets/Sets the direction of the text flow for this object. The value of the property is TextDirectionType integer constant.

Example:

if (shape.getTextDirection() == com.aspose.cells.TextDirectionType.CONTEXT)
    shape.setTextDirection(com.aspose.cells.TextDirectionType.LEFT_TO_RIGHT);

getControlData

→ inherited from Shape
public byte[] getControlData()
Gets the data of control.

Example:

if(shape.getControlData() == null)
    System.out.println("No data.");

getActiveXControl

→ inherited from Shape
public ActiveXControl getActiveXControl()
Gets the ActiveX control.

Example:

CheckBoxActiveXControl checkBox1 = (CheckBoxActiveXControl)shape.getActiveXControl();
//The font name of CheckBox
String fontName = checkBox1.getFont().getName();

getPaths

→ inherited from Shape
public ShapePathCollection getPaths()
Gets the paths of a custom geometric shape.

Example:

//Returns non-null if there is a path to the custom geometry
if(shape.getPaths() == null)
    System.out.println("No custom geometry path.");

getGeometry

→ inherited from Shape
public Geometry getGeometry()
Gets the geometry

Example:

if (shape.getGeometry().getShapeAdjustValues().getCount() == 0)
    System.out.println("No geometry path.");

getCreateId

→ inherited from Shape
public java.util.UUID getCreateId()
Gets and sets create id for this shape.

Method Detail

getLinkedCell

→ inherited from Shape
public java.lang.String getLinkedCell(boolean isR1C1, boolean isLocal)
Gets the range linked to the control's value.
Parameters:
isR1C1 - Whether the formula needs to be formatted as R1C1.
isLocal - Whether the formula needs to be formatted by locale.
Returns:
The range linked to the control's value.

Example:

//You may get results like '$A$1'
String link = shape.getLinkedCell(false, false);

setLinkedCell

→ inherited from Shape
public void setLinkedCell(java.lang.String formula, boolean isR1C1, boolean isLocal)
Sets the range linked to the control's value.
Parameters:
formula - The range linked to the control's value.
isR1C1 - Whether the formula needs to be formatted as R1C1.
isLocal - Whether the formula needs to be formatted by locale.

Example:

//After executing the code below, a ScrollBar object is created in the generated file. As you drag the slider, the value is displayed in cell A12.

//ActiveX Controls
//Aspose.Cells.Drawing.Shape scrollBar = book.Worksheets[0].Shapes.AddActiveXControl( Aspose.Cells.Drawing.ActiveXControls.ControlType.ScrollBar,2, 0, 2, 0, 30, 130);

//Form Controls
Shape scrollBar = book.getWorksheets().get(0).getShapes().addScrollBar(2, 0, 2, 0, 130, 30);

//Sets the range linked to the control's value.
scrollBar.setLinkedCell("$A$12", false, true);

getInputRange

→ inherited from Shape
public java.lang.String getInputRange(boolean isR1C1, boolean isLocal)
Gets the range used to fill the control.
Parameters:
isR1C1 - Whether the formula needs to be formatted as R1C1.
isLocal - Whether the formula needs to be formatted by locale.
Returns:
The range used to fill the control.

Example:

String range = shape.getInputRange(false, true);
//If successful, a value like "$A$1:$A$3" will be returned

setInputRange

→ inherited from Shape
public void setInputRange(java.lang.String formula, boolean isR1C1, boolean isLocal)
Sets the range used to fill the control.
Parameters:
formula - The range used to fill the control.
isR1C1 - Whether the formula needs to be formatted as R1C1.
isLocal - Whether the formula needs to be formatted by locale.

Example:

//After executing the code below, a ListBox object is created in the generated file. When the selected option is clicked, the selected value is displayed in cell A12.

//Initialize a new workbook.
//Workbook book = new Workbook();
        
for (int i = 0; i< 10; ++i)
{
    Cell cell = book.getWorksheets().get(0).getCells().get(i, 0);
    cell.setValue(i + 1);
}
   
//Create a ListBox object

//ActiveX Controls
//Aspose.Cells.Drawing.Shape listBox = book.Worksheets[0].Shapes.AddActiveXControl( Aspose.Cells.Drawing.ActiveXControls.ControlType.ListBox,2, 0, 2, 0, 130, 130);

//Form Controls
Shape listBox = book.getWorksheets().get(0).getShapes().addListBox(2, 0, 2, 0, 130, 130);

//Sets the range used to fill the control.
listBox.setInputRange("$A$1:$A$6", false, false);

//Sets the range linked to the control's value.
listBox.setLinkedCell("$A$12", false, true);

updateSelectedValue

→ inherited from Shape
public void updateSelectedValue()
                        throws java.lang.Exception
Update the selected value by the value of the linked cell.

Example:

//Initialize a new workbook.
//Workbook book = new Workbook();
        
Cell cell = null;
for (int i = 0; i< 10; ++i)
{
    cell = book.getWorksheets().get(0).getCells().get(i, 0);
    cell.setValue(i + 1);
}
   
//Create a ListBox object

//ActiveX Controls
//Aspose.Cells.Drawing.Shape listBox = book.Worksheets[0].Shapes.AddActiveXControl( Aspose.Cells.Drawing.ActiveXControls.ControlType.ListBox,2, 0, 2, 0, 130, 130);

//Form Controls
Shape listBox = book.getWorksheets().get(0).getShapes().addListBox(2, 0, 2, 0, 130, 130);

//Sets the range used to fill the control.
listBox.setInputRange("$A$1:$A$6", false, false);

//Sets the range linked to the control's value.
listBox.setLinkedCell("$A$12", false, true);

ListBox listbx = (ListBox)listBox;

//Set the value of cell A12
cell = book.getWorksheets().get(0).getCells().get(11, 0);
cell.setValue(3);

//Update the selected value by the value of the linked cell.
listBox.updateSelectedValue();

//-1 default, no option selected
if(listbx.isSelected(2))
{
    //Option 3 of the ListBox is selected
}

//Change the value of a linked cell
cell.setValue(4);

//Update the selected value by the value of the linked cell.
listBox.updateSelectedValue();
if(listbx.isSelected(3))
{
    //Option 4 of the ListBox is selected
}

calculateTextSize

→ inherited from Shape
public int[] calculateTextSize()
                       throws java.lang.Exception
Recalculate the text area
Returns:
Text's Size in an array(width and height).

Example:

//The size of the text area is:w=size[0],h=size[1]
int[] size = shape.calculateTextSize();

formatCharacters

→ inherited from Shape
public void formatCharacters(int startIndex, int length, Font font, StyleFlag flag)
                     throws java.lang.Exception
Formats some characters with the font setting.
Parameters:
startIndex - The start index.
length - The length.
font - The font setting.
flag - The flag of the font setting.

formatCharacters

→ inherited from Shape
public void formatCharacters(int startIndex, int length, Font font)
Formats some characters with the font setting. NOTE: This member is now obsolete. Instead, please use Shape.FormatCharacters(int startIndex, int length, Font font, StyleFlag flag) method. This property will be removed 12 months later since March 2016. Aspose apologizes for any inconvenience you may have experienced.
Parameters:
startIndex - The start index.
length - The length.
font - The font setting.

characters

→ inherited from Shape
public FontSetting characters(int startIndex, int length)
Returns a Characters object that represents a range of characters within the text. This method only works on shape with title.
Parameters:
startIndex - The index of the start of the character.
length - The number of characters.
Returns:
Characters object.

Example:

FontSetting fontSetting = shape.characters(0, 4);

getCharacters

→ inherited from Shape
public java.util.ArrayList getCharacters()
                       throws java.lang.Exception
Returns all Characters objects that represents a range of characters within the text .
Returns:
All Characters objects

Example:

ArrayList list = shape.getCharacters();

removeActiveXControl

→ inherited from Shape
public void removeActiveXControl()
Remove activeX control.

Example:

shape.removeActiveXControl();

isSameSetting

→ inherited from Shape
public boolean isSameSetting(java.lang.Object obj)
Returns whether the shape is same.
Parameters:
obj -
Returns:

Example:

if (shape.isSameSetting(shape))
    System.out.println("Two objects the same.");

getConnectionPoints

→ inherited from Shape
public float[][] getConnectionPoints()
Get the connection points
Returns:
[X,Y] pairs of the connection point. Every item is a float[2] array, [0] represents x and [1] represents y.

Example:

float[][] points = shape.getConnectionPoints();

toImage

→ inherited from Shape
public void toImage(java.io.OutputStream stream, ImageFormat imageFormat)
            throws java.lang.Exception
Creates the shape image and saves it to a stream in the specified format.

The following formats are supported: .bmp, .gif, .jpg, .jpeg, .tiff, .emf.

Parameters:
stream - The output stream.
imageFormat - The format in which to save the image.

toImage

→ inherited from Shape
public void toImage(java.lang.String imageFile, ImageOrPrintOptions options)
            throws java.lang.Exception
Saves the shape to a file.

Example:

ImageOrPrintOptions op = new ImageOrPrintOptions();
shape.toImage("exmaple.png", op);

toImage

→ inherited from Shape
public void toImage(java.io.OutputStream stream, ImageOrPrintOptions options)
            throws java.lang.Exception
Saves the shape to a stream.

getResultOfSmartArt

→ inherited from Shape
public GroupShape getResultOfSmartArt()
                              throws java.lang.Exception
Converting smart art to grouped shapes.

Example:

GroupShape groupShape = shape.getResultOfSmartArt();

toFrontOrBack

→ inherited from Shape
public void toFrontOrBack(int orders)
Brings the shape to the front or sends the shape to back.
Parameters:
orders - If it's less than zero, sets the shape to back. If it's greater than zero, brings the shape to front.

Example:

shape.toFrontOrBack(2);
//or shape.ToFrontOrBack(-1);

getLockedProperty

→ inherited from Shape
public boolean getLockedProperty(int type)
Gets the value of locked property.
Parameters:
type - A ShapeLockType value. The type of the shape locked property.
Returns:
Returns the value of locked property.

Example:

int noAdjustHandles = 0;
if (shape.getLockedProperty(ShapeLockType.ADJUST_HANDLES))
    noAdjustHandles = 1;

setLockedProperty

→ inherited from Shape
public void setLockedProperty(int type, boolean value)
Set the locked property.
Parameters:
type - A ShapeLockType value. The locked type.
value - The value of the property.

Example:

shape.setLockedProperty(ShapeLockType.ADJUST_HANDLES, true);

addHyperlink

→ inherited from Shape
public Hyperlink addHyperlink(java.lang.String address)
Adds a hyperlink to the shape.
Parameters:
address - Address of the hyperlink.
Returns:
Return the new hyperlink object.

Example:

Hyperlink hyperlink = shape.addHyperlink("https://www.aspose.com/");

removeHyperlink

→ inherited from Shape
public void removeHyperlink()
Remove the hyperlink of the shape.

Example:

shape.removeHyperlink();

moveToRange

→ inherited from Shape
public void moveToRange(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn)
Moves the shape to a specified range.
Parameters:
upperLeftRow - Upper left row index.
upperLeftColumn - Upper left column index.
lowerRightRow - Lower right row index
lowerRightColumn - Lower right column index

Example:

shape.moveToRange(12, 3, 13, 5);

alignTopRightCorner

→ inherited from Shape
public void alignTopRightCorner(int topRow, int rightColumn)
Moves the picture to the top-right corner.
Parameters:
topRow - the row index.
rightColumn - the column index.

Example:

shape.alignTopRightCorner(2, 5);

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.