Mioplanet Documentation Center
Resources and Help
HomeProductsMioScriptJavaScriptTechNotesPHP
   Home | MioScript | window.autoShape.start SEARCH    

  Functions
window.autoShape.apply
window.autoShape.end
window.autoShape.start
window.cancelClose
window.count
window.create
window.eventAuthor
window.exists
window.fadeIn
window.fadeOut
window.fromPoint
window.group.count
window.group.getList
window.ID.appBar.enable
window.ID.appBar.refreshPos
window.ID.appBar.setPos
window.ID.autoClose
window.ID.border.bottom
window.ID.border.left
window.ID.border.right
window.ID.border.top
window.ID.borderIcon
window.ID.borderStyle
window.ID.bringToFront
window.ID.cancelClose
window.ID.canGoOut
window.ID.clientArea
window.ID.clientHeight
window.ID.clientWidth
window.ID.close
window.ID.create
window.ID.enabled
window.ID.formStyle
window.ID.getParentId
window.ID.group.get
window.ID.group.set
window.ID.handle
window.ID.height
window.ID.icon
window.ID.image.load
window.ID.left
window.ID.monitor.height
window.ID.monitor.index
window.ID.monitor.left
window.ID.monitor.top
window.ID.monitor.width
window.ID.movable
window.ID.parent
window.ID.parent.height
window.ID.parent.left
window.ID.parent.top
window.ID.parent.width
window.ID.pos.now
window.ID.pos.rel
window.ID.repaint
window.ID.sendToBack
window.ID.setFocus
window.ID.setForegroundWindow
window.ID.shape.elliptic
window.ID.shape.from.ID
window.ID.shape.load
window.ID.shape.polygon
window.ID.shape.rect
window.ID.state
window.ID.statusIcon.hide
window.ID.statusIcon.show
window.ID.stayOnTop
window.ID.title
window.ID.tooltip
window.ID.top
window.ID.transparency
window.ID.visible
window.ID.width
window.ID.zInsertAfter
window.ID.zOrder

  Events
event.appBar:posChanged
event.minimize
event.resize
event.restore
event.statusIcon:mouse:dblClick
event.statusIcon:mouse:down
event.statusIcon:mouse:move
event.statusIcon:mouse:right:dblClick
event.statusIcon:mouse:right:down
event.statusIcon:mouse:right:up
event.statusIcon:mouse:up
event.window:close
event.window:gotFocus
event.window:lostFocus
event.window:move

  MioScript Reference
> Statements
app...
browser...
dialog...
disk...
draw...
extern...
filename...
keyboard...
menu...
mio...
mouse...
num...
path...
pushButton...
reg...
RS232...
sci...
screen...
shortcut...
sound...
str...
system...
time...
var...
window...

Function
window.autoShape.start

Language: MioScript
Product: MioFactory


Syntax

window.autoShape.start()


Parameters

None.


Return value

No value is returned.


Description

A dynamic shape is a way to set the shape of a window depending on the content of the HTML document rendered in the specified web browser object.
The shape is applied to the window embedding the browser object.

The shape is defined by a transparent color defined by the first pixel in the top-left part of the HTML document.


In this example, two DIV tags are visible. When autoShape is applied,
the grey part is invisible as the color of the first pixel in the top left part of
the browser object is set as transparent color.



Dynamic shape is useful to animate a window, for example to open a side panel, to switch to another shape, etc.
The animation is done in DHTML/JavaScript, Flash or any other embedded component, and the shape of the window is automatically set in real-time.

For more information about the shape of the window and the transparent color: window.autoShape.apply.

When window.autoShape.start is called, MioEngine hides the web browser object, and renders continuously the image of the browser object and the shape of the window.

As the browser object is hidden and only a bitmap is drawn over the window, the user cannot interact with the application.

When the function window.autoShape.end is called, the shape is fixed, and the user can interact with the application again.

You should proceed as follow:

- Call window.autoShape.start

- Animate your HTML document, for example to open or close a side panel.

- Call window.autoShape.end.

If you want to apply a shape with no animation, you can use window.autoShape.apply.

mio.autoShape.start can also be called from JavaScript with mio_autoShape_start.