GraphFrame — C# API

class GraphFrameReckfellSharpInherits GraphElement

GraphFrame and its grouped GraphElement objects remain direct children of the same GraphEdit. Link them with GraphEdit.AttachGraphElementToFrame using element/frame Name values; unlink with DetachGraphElementFromFrame. This is a graph relationship rather than Reparent or memory ownership. Merely placing elements inside the rectangle does not establish membership.

Title is the visible caption, separate from Entity.Name used by relationships. Do not use the displayed title as a key. Update your model and links when renaming identifiers; change only Title for a new caption.

AutoshrinkEnabled defaults to true: GraphEdit computes an enclosing frame around attached elements using AutoshrinkMargin. This does not fit the frame around tree children. For manual sizing, disable AutoshrinkEnabled and enable inherited Resizable; content constraints and GraphEdit snapping may still restrict size.

Installed SDK 1.0.0 has an AutoshrinkChanged mismatch: the C# event declares no arguments, but the native signal carries a Vector2 size. Ordinary += subscription causes an argument-count error. If the application needs this notification, use Connect(GraphFrame.SignalName.AutoshrinkChanged, Callable.From<Vector2>(handler)), with a Vector2 handler. Retain the same Callable for Disconnect. This works around the SDK limitation rather than fixing the engine.

GetTitlebarHBox returns the frame-owned internal container. You can add your button to it, but must not free or reparent the container itself. TintColorEnabled enables the custom body tint; assigning TintColor alone does not enable it. DragMargin sets the edge grab region width, separate from the outer AutoshrinkMargin. The whole frame interior is not a grab button.

Freeing the frame does not mean deleting grouped elements: they belong to GraphEdit. When removing a group, decide whether its model elements survive, remove links, and explicitly free the required objects.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

GraphFrameConstructor

# GraphFrame

C#
public GraphFrame();

Creates a frame: AutoshrinkEnabled = true, AutoshrinkMargin = 40, DragMargin = 16, TintColorEnabled = false. The built-in titlebar belongs to the frame.

Properties6

AutoshrinkEnabledProperty

# AutoshrinkEnabled

C#
public bool AutoshrinkEnabled { get; set; }

Allows GraphEdit to enclose attached elements automatically, default true. Disable for manual sizing; this neither reparents nor automatically deletes elements.

AutoshrinkMarginProperty

# AutoshrinkMargin

C#
public int AutoshrinkMargin { get; set; }

Margin around attached elements in graph coordinates, default 40. Use a nonnegative value. A change emits native AutoshrinkChanged.

DragMarginProperty

# DragMargin

C#
public int DragMargin { get; set; }

Edge grab region width in frame-local units, default 16. Neither the outer enclosing margin nor child-container padding.

TintColorProperty

# TintColor

C#
public Color TintColor { get; set; }

Stored custom body tint. Assignment neither enables TintColorEnabled nor modifies the shared theme resource; drawing depends on the StyleBox.

TintColorEnabledProperty

# TintColorEnabled

C#
public bool TintColorEnabled { get; set; }

Enables the custom frame-body tint, default false. Does not change selection or set the title text color.

TitleProperty

# Title

C#
public string Title { get; set; }

Visible frame caption, independent of Entity.Name and GraphEdit membership keys.

Methods13

GetAutoshrinkMarginint

# GetAutoshrinkMargin

C#
public int GetAutoshrinkMargin();

Margin around attached elements in graph coordinates, default 40. Use a nonnegative value. A change emits native AutoshrinkChanged.

Returns int

Margin around attached elements in graph coordinates, default 40. Use a nonnegative value. A change emits native AutoshrinkChanged.

GetDragMarginint

# GetDragMargin

C#
public int GetDragMargin();

Edge grab region width in frame-local units, default 16. Neither the outer enclosing margin nor child-container padding.

Returns int

Edge grab region width in frame-local units, default 16. Neither the outer enclosing margin nor child-container padding.

GetTintColorColor

# GetTintColor

C#
public Color GetTintColor();

Stored custom body tint. Assignment neither enables TintColorEnabled nor modifies the shared theme resource; drawing depends on the StyleBox.

Returns Color

Stored custom body tint. Assignment neither enables TintColorEnabled nor modifies the shared theme resource; drawing depends on the StyleBox.

GetTitlestring

# GetTitle

C#
public string GetTitle();

Visible frame caption, independent of Entity.Name and GraphEdit membership keys.

Returns string

Visible frame caption, independent of Entity.Name and GraphEdit membership keys.

GetTitlebarHBoxHBoxContainer

# GetTitlebarHBox

C#
public HBoxContainer GetTitlebarHBox();

Returns the frame-owned internal HBoxContainer. Add your controls, but do not free or reparent the container itself.

Returns HBoxContainer

Returns the frame-owned internal HBoxContainer. Add your controls, but do not free or reparent the container itself.

IsAutoshrinkEnabledbool

# IsAutoshrinkEnabled

C#
public bool IsAutoshrinkEnabled();

Allows GraphEdit to enclose attached elements automatically, default true. Disable for manual sizing; this neither reparents nor automatically deletes elements.

Returns bool

Allows GraphEdit to enclose attached elements automatically, default true. Disable for manual sizing; this neither reparents nor automatically deletes elements.

IsTintColorEnabledbool

# IsTintColorEnabled

C#
public bool IsTintColorEnabled();

Enables the custom frame-body tint, default false. Does not change selection or set the title text color.

Returns bool

Enables the custom frame-body tint, default false. Does not change selection or set the title text color.

SetAutoshrinkEnabledvoid

# SetAutoshrinkEnabled

C#
public void SetAutoshrinkEnabled(bool shrink);

Allows GraphEdit to enclose attached elements automatically, default true. Disable for manual sizing; this neither reparents nor automatically deletes elements.

Parameters
Name	Type	Default
`shrink`	`bool`	—

shrink

Allows GraphEdit to enclose attached elements automatically, default true. Disable for manual sizing; this neither reparents nor automatically deletes elements.

SetAutoshrinkMarginvoid

# SetAutoshrinkMargin

C#
public void SetAutoshrinkMargin(int autoshrinkMargin);

Margin around attached elements in graph coordinates, default 40. Use a nonnegative value. A change emits native AutoshrinkChanged.

Parameters
Name	Type	Default
`autoshrinkMargin`	`int`	—

autoshrinkMargin

Margin around attached elements in graph coordinates, default 40. Use a nonnegative value. A change emits native AutoshrinkChanged.

SetDragMarginvoid

# SetDragMargin

C#
public void SetDragMargin(int dragMargin);

Edge grab region width in frame-local units, default 16. Neither the outer enclosing margin nor child-container padding.

Parameters
Name	Type	Default
`dragMargin`	`int`	—

dragMargin

Edge grab region width in frame-local units, default 16. Neither the outer enclosing margin nor child-container padding.

SetTintColorvoid

# SetTintColor

C#
public void SetTintColor(Color color);

Stored custom body tint. Assignment neither enables TintColorEnabled nor modifies the shared theme resource; drawing depends on the StyleBox.

Parameters
Name	Type	Default
`color`	`Color`	—

color

Stored custom body tint. Assignment neither enables TintColorEnabled nor modifies the shared theme resource; drawing depends on the StyleBox.

SetTintColorEnabledvoid

# SetTintColorEnabled

C#
public void SetTintColorEnabled(bool enable);

Enables the custom frame-body tint, default false. Does not change selection or set the title text color.

Parameters
Name	Type	Default
`enable`	`bool`	—

enable

Enables the custom frame-body tint, default false. Does not change selection or set the title text color.

SetTitlevoid

# SetTitle

C#
public void SetTitle(string title);

Visible frame caption, independent of Entity.Name and GraphEdit membership keys.

Parameters
Name	Type	Default
`title`	`string`	—

title

Visible frame caption, independent of Entity.Name and GraphEdit membership keys.

Signals and events1

AutoshrinkChangedEvent

# AutoshrinkChanged

public event Action AutoshrinkChanged;

Installed SDK 1.0.0 limitation: the C# event has no arguments, while the native signal carries Vector2. Ordinary += subscription causes an argument-count error. Use Connect with Callable.From<Vector2>(handler) and GraphFrame.SignalName.AutoshrinkChanged; reread the frame settings.

Theme properties

These are Theme resource keys, not C# properties. Use the matching Control GetTheme…() and AddTheme…Override() methods for each value type.

Key and type	Description
`resizer_color` `Color`	The color modulation applied to the resizer icon. Default: `Color(0.875, 0.875, 0.875, 1)`
`panel` `StyleBox`	The default `StyleBox` used for the background of the `GraphFrame`.
`panel_selected` `StyleBox`	The `StyleBox` used for the background of the `GraphFrame` when it is selected.
`titlebar` `StyleBox`	The `StyleBox` used for the title bar of the `GraphFrame`.
`titlebar_selected` `StyleBox`	The `StyleBox` used for the title bar of the `GraphFrame` when it is selected.