IHeaderButtonHandler

References
public interface IHeaderButtonHandler
This interface represents a handler for putting custom buttons on the header of IRhinoUiSection.

Methods

ButtonDetails

#Since v7.4
bool ButtonDetails(int index, ref Bitmap iconOut, ref string sToolTipOut)
Implement this method to describe custom buttons on the section header. RDK calls this method continually increasing iIndex until it returns \e false
Parameters:
index (int)index is the button index starting at zero and increasing with each call.
iconOut (ref Bitmap)iconOut accepts the button's imagery, or 'icon'. If an icon is not required, do not set this parameter.
sToolTipOut (ref string)sToolTipOut accepts the button's tool-tip. If a tool-tip is not required, do not set this parameter.
Returns: \e true if button is required, \e false to stop.

ButtonRect

#Since v7.4
Rectangle ButtonRect(int index, Rectangle rectHeader)
Implement this method to get the rectangle of a button on the header window.
Parameters:
index (int)index is the index of the button.
rectHeader (Rectangle)rectHeader is the usable area of the header where the buttons can be placed.
Returns: The rectangle of the button.

DeleteThis

#Since v7.4
void DeleteThis()

OnButtonClicked

#Since v7.4
bool OnButtonClicked(int index)
Implement this method to handle a button click.
Parameters:
index (int)index is the index of the button that was clicked
Returns: \e true if handled successfully, else \e false.