com.aspose.words

Class OleControl

java.lang.Object

com.aspose.words.OleControl

Direct Known Subclasses:

Forms2OleControl

public class OleControl
extends java.lang.Object

Represents OLE ActiveX control.

To learn more, visit the Working with Ole Objects documentation article.

Examples:

Shows how to verify the properties of an ActiveX control.

 
 Document doc = new Document(getMyDir() + "ActiveX controls.docx");

 Shape shape = (Shape) doc.getChild(NodeType.SHAPE, 0, true);
 OleControl oleControl = shape.getOleFormat().getOleControl();

 Assert.assertEquals(oleControl.getName(), "CheckBox1");

 if (oleControl.isForms2OleControl()) {
     Forms2OleControl checkBox = (Forms2OleControl) oleControl;
     Assert.assertEquals(checkBox.getCaption(), "First");
     Assert.assertEquals(checkBox.getValue(), "0");
     Assert.assertEquals(checkBox.getEnabled(), true);
     Assert.assertEquals(checkBox.getType(), Forms2OleControlType.CHECK_BOX);
     Assert.assertEquals(checkBox.getChildNodes(), null);
 }
 
 

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CHECK_BOX_CONTROL_CLSID
protected static java.lang.String	COMBO_BOX_CONTROL_CLSID
protected static java.lang.String	COMMAND_BUTTON_CONTROL_CLSID
protected static java.lang.String	FORM_CONTROL_CLSID
protected static java.lang.String	FRAME_CONTROL_CLSID
protected static java.lang.String	HTML_HIDDEN_CLSID
protected static java.lang.String	HTML_SELECT_CLSID
protected static java.lang.String	HTML_SUBMIT_BUTTON_CLSID
protected static java.lang.String	HTML_TEXT_CLSID
protected static java.lang.String	IMAGE_CONTROL_CLSID
protected static java.lang.String	LABEL_CONTROL_CLSID
protected static java.lang.String	LIST_BOX_CONTROL_CLSID
protected static java.lang.String	MULTI_PAGE_CONTROL_CLSID
protected static java.lang.String	OPTION_BUTTON_CONTROL_CLSID
protected static java.lang.String	SCROLL_BAR_CONTROL_CLSID
protected static java.lang.String	SPIN_BUTTON_CONTROL_CLSID
protected static java.lang.String	TAB_STRIP_CONTROL_CLSID
protected static java.lang.String	TEXT_BOX_CONTROL_CLSID
protected static java.lang.String	TOGGLE_BUTTON_CONTROL_CLSID

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClsidInternal()
protected java.lang.String	getClsidVirtual()
java.lang.String	getExtensionForUser(java.lang.String progId)
java.lang.String	getFileNameForUser()
int	getId()
java.lang.String	getName() Gets name of the ActiveX control.
protected java.lang.String	getProgId()
protected java.lang.String	getUserType()
boolean	isEmpty()
boolean	isForms2OleControl() Returns true if the control is a Forms2OleControl.
boolean	isForms2OleControlInternal()
void	setId(int value)
void	setName(java.lang.String value) Sets name of the ActiveX control.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HTML_SELECT_CLSID

protected static java.lang.String HTML_SELECT_CLSID

HTML_SUBMIT_BUTTON_CLSID

protected static java.lang.String HTML_SUBMIT_BUTTON_CLSID

HTML_HIDDEN_CLSID

protected static java.lang.String HTML_HIDDEN_CLSID

HTML_TEXT_CLSID

protected static java.lang.String HTML_TEXT_CLSID

OPTION_BUTTON_CONTROL_CLSID

protected static java.lang.String OPTION_BUTTON_CONTROL_CLSID

LABEL_CONTROL_CLSID

protected static java.lang.String LABEL_CONTROL_CLSID

TEXT_BOX_CONTROL_CLSID

protected static java.lang.String TEXT_BOX_CONTROL_CLSID

CHECK_BOX_CONTROL_CLSID

protected static java.lang.String CHECK_BOX_CONTROL_CLSID

TOGGLE_BUTTON_CONTROL_CLSID

protected static java.lang.String TOGGLE_BUTTON_CONTROL_CLSID

SPIN_BUTTON_CONTROL_CLSID

protected static java.lang.String SPIN_BUTTON_CONTROL_CLSID

COMBO_BOX_CONTROL_CLSID

protected static java.lang.String COMBO_BOX_CONTROL_CLSID

COMMAND_BUTTON_CONTROL_CLSID

protected static java.lang.String COMMAND_BUTTON_CONTROL_CLSID

IMAGE_CONTROL_CLSID

protected static java.lang.String IMAGE_CONTROL_CLSID

SCROLL_BAR_CONTROL_CLSID

protected static java.lang.String SCROLL_BAR_CONTROL_CLSID

TAB_STRIP_CONTROL_CLSID

protected static java.lang.String TAB_STRIP_CONTROL_CLSID

LIST_BOX_CONTROL_CLSID

protected static java.lang.String LIST_BOX_CONTROL_CLSID

FORM_CONTROL_CLSID

protected static java.lang.String FORM_CONTROL_CLSID

FRAME_CONTROL_CLSID

protected static java.lang.String FRAME_CONTROL_CLSID

MULTI_PAGE_CONTROL_CLSID

protected static java.lang.String MULTI_PAGE_CONTROL_CLSID

Method Detail

getName

public java.lang.String getName()

Gets name of the ActiveX control.

Examples:

Shows how to verify the properties of an ActiveX control.

 
 Document doc = new Document(getMyDir() + "ActiveX controls.docx");

 Shape shape = (Shape) doc.getChild(NodeType.SHAPE, 0, true);
 OleControl oleControl = shape.getOleFormat().getOleControl();

 Assert.assertEquals(oleControl.getName(), "CheckBox1");

 if (oleControl.isForms2OleControl()) {
     Forms2OleControl checkBox = (Forms2OleControl) oleControl;
     Assert.assertEquals(checkBox.getCaption(), "First");
     Assert.assertEquals(checkBox.getValue(), "0");
     Assert.assertEquals(checkBox.getEnabled(), true);
     Assert.assertEquals(checkBox.getType(), Forms2OleControlType.CHECK_BOX);
     Assert.assertEquals(checkBox.getChildNodes(), null);
 }
 
 

Returns:

Name of the ActiveX control.

setName

public void setName(java.lang.String value)

Sets name of the ActiveX control.

Examples:

Shows how to verify the properties of an ActiveX control.

 
 Document doc = new Document(getMyDir() + "ActiveX controls.docx");

 Shape shape = (Shape) doc.getChild(NodeType.SHAPE, 0, true);
 OleControl oleControl = shape.getOleFormat().getOleControl();

 Assert.assertEquals(oleControl.getName(), "CheckBox1");

 if (oleControl.isForms2OleControl()) {
     Forms2OleControl checkBox = (Forms2OleControl) oleControl;
     Assert.assertEquals(checkBox.getCaption(), "First");
     Assert.assertEquals(checkBox.getValue(), "0");
     Assert.assertEquals(checkBox.getEnabled(), true);
     Assert.assertEquals(checkBox.getType(), Forms2OleControlType.CHECK_BOX);
     Assert.assertEquals(checkBox.getChildNodes(), null);
 }
 
 

Parameters:

value - Name of the ActiveX control.

isForms2OleControl

public boolean isForms2OleControl()

Returns true if the control is a Forms2OleControl.

Examples:

Shows how to verify the properties of an ActiveX control.

 
 Document doc = new Document(getMyDir() + "ActiveX controls.docx");

 Shape shape = (Shape) doc.getChild(NodeType.SHAPE, 0, true);
 OleControl oleControl = shape.getOleFormat().getOleControl();

 Assert.assertEquals(oleControl.getName(), "CheckBox1");

 if (oleControl.isForms2OleControl()) {
     Forms2OleControl checkBox = (Forms2OleControl) oleControl;
     Assert.assertEquals(checkBox.getCaption(), "First");
     Assert.assertEquals(checkBox.getValue(), "0");
     Assert.assertEquals(checkBox.getEnabled(), true);
     Assert.assertEquals(checkBox.getType(), Forms2OleControlType.CHECK_BOX);
     Assert.assertEquals(checkBox.getChildNodes(), null);
 }
 
 

Returns:

true if the control is a Forms2OleControl.

getExtensionForUser

public java.lang.String getExtensionForUser(java.lang.String progId)

getFileNameForUser

public java.lang.String getFileNameForUser()

isForms2OleControlInternal

public boolean isForms2OleControlInternal()

getClsidInternal

public java.lang.String getClsidInternal()

getId

public int getId()

setId

public void setId(int value)

isEmpty

public boolean isEmpty()

getClsidVirtual

protected java.lang.String getClsidVirtual()

getUserType

protected java.lang.String getUserType()

getProgId

protected java.lang.String getProgId()