FloatingObject type

Represents a floating object.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GC.Spread.Sheets.FloatingObjects.FloatingObject(name, x, y, width, height);

function FloatingObject;

Example

Javascript

//This example creates a floating object.
var customFloatingObject = new GC.Spread.Sheets.FloatingObjects.FloatingObject("f1", 10, 10, 60, 64);
var btn = document.createElement('button');
btn.style.width = "60px";
btn.style.height = "30px";
btn.innerText = "button";
customFloatingObject.content(btn);
activeSheet.floatingObjects.add(customFloatingObject);

Remarks

This is a base class that is intended for internal use.

Inheritance Hierarchy

Object
   GC.Spread.Sheets.FloatingObjects.FloatingObject
      GC.Spread.Sheets.Charts.Chart
      GC.Spread.Sheets.FloatingObjects.Picture

Constructors

	Name	Description
	FloatingObject Constructor	Represents a floating object.

Top

Fields

	Name	Description
	typeName	Represents the type name string used for supporting serialization.

Top

Methods

	Name	Description
	allowMove	Gets or sets whether to disable moving the floating object.
	allowResize	Gets or sets whether to disable resizing the floating object.
	cloneContent	Gets a copy of the current content of the instance.
	content	Gets or sets the content of the custom floating object.
	dynamicMove	Gets or sets whether the object moves when hiding or showing, resizing, or moving rows or columns.
	dynamicSize	Gets or sets whether the size of the object changes when hiding or showing, resizing, or moving rows or columns.
	endColumn	Gets or sets the end column index of the floating object position.
	endColumnOffset	Gets or sets the offset relative to the end column of the floating object.
	endRow	Gets or sets the end row index of the floating object position.
	endRowOffset	Gets or sets the offset relative to the end row of the floating object.
	fixedPosition	Gets or sets whether the position of the floating object is fixed. When fixedPosition is true, dynamicMove and dynamicSize are disabled.
	getHost	Gets the dom host of the custom content.
	height	Gets or sets the height of a floating object.
	isLocked	Gets or sets whether this floating object is locked.
	isSelected	Gets or sets whether this floating object is selected.
	isVisible	Gets or sets whether this floating object is visible.
	name	Gets the name of the floating object.
	refreshContent	Refresh the content in floatingObject.The user should override this method to make their content synchronize with the floatingObject.
	startColumn	Gets or sets the starting column index of the floating object position.
	startColumnOffset	Gets or sets the offset relative to the start column of the floating object.
	startRow	Gets or sets the starting row index of the floating object position.
	startRowOffset	Gets or sets the offset relative to the start row of the floating object.
	width	Gets or sets the width of a floating object.
	x	Gets or sets the horizontal location of the floating object.
	y	Gets or sets the vertical location of the floating object.

Top

Reference

GC.Spread.Sheets.FloatingObjects Namespace
Creating Custom Floating Objects