c4d.gui.LinkBoxGui¶

class c4d.gui.LinkBoxGui¶

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

This is what it looks like:

Parent Class:

Overview¶

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

LinkBoxGui.GetLink(self, doc, instance)¶

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

Parameters

Returns

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

Return type

Optional[c4d.BaseList2D]

LinkBoxGui.SetLink(self, obj)¶

Sets the link.

Category	Option	Description
Query	Words and phrases	Search is case-insensitive. Put a phrase in quotes for an exact match. Quoted phrases require every word and disable fuzzy matching.
Terms	OR / AND	Choose whether to match any term or require all terms.
Fuzzy	On / Off	Toggle approximate and prefix matches. Quoted phrases always use strict matching.
Results	Sparse / Dense	Sparse groups multiple hits for one entity and hides its owned API members when the class or module itself matches. Dense lists each match separately.
Sort by	Type / Relevance	Group results by entity type then rank within each group, or rank all results by relevance.
Content	All / API / Manuals / Examples / Resources	Search all documentation, API documentation, manuals, the examples index, or the resources index. Code examples embedded in other sections retain their own content area.
Entity	All / Page / Module / Class / Function / Attribute / Description / Node / Symbol / Icon	Page covers results without a specific entity type. Resource entity types are available with All or Resources; API entity types are available with All or API.
Location	All / Text / Code / Name / Signature	Text covers everything outside code, names, and signatures. Name and Signature are available with All or API.