c4d.gui.LinkBoxGui

class c4d.gui.LinkBoxGui

Link box GUI(CUSTOMGUI_LINKBOX) for BaseList2D objects. These are the settings:

Symbol ID	Type	Description
LINKBOX_HIDE_ICON	bool	Hide the icon.
LINKBOX_LAYERMODE	bool	Layer mode.
LINKBOX_NO_PICKER	bool	No picker mode.
LINKBOX_NODE_MODE	bool	Private - Node mode.

This is what it looks like:

Methods Signatures

LinkBoxGui.SetLink()	Sets the link.
LinkBoxGui.GetLink()	Evaluates the link in doc, returning None if the linked object is not an instance of instance.

Inheritance

Parent Class:

• c4d.gui.BaseCustomGui

Methods Documentation

LinkBoxGui.SetLink(self, obj)

Sets the link.

Parameters

obj (c4d.BaseList2D) – The object to set.

Return type

bool

Returns

True if the object was set, otherwise False.

LinkBoxGui.GetLink(self, doc, instance)

Evaluates the link in doc, returning None if the linked object is not an instance of instance.

Parameters

• doc (c4d.documents.BaseDocument) – Document to evaluate the link in.

• instance (int) – The type to check.

Returns

The linked object, or None if the link is broken or of the wrong type.

Return type

Optional[c4d.BaseList2D]