BinarySuperToolTip

Initialises a new super tool tip component, with no tips set for any control yet.

Give each control its tip with SetBinarySuperToolTipBodyText and the other SetBinarySuperToolTip... methods.

Gets a value that is always true: the component always draws its tips itself.

Gets the colour a gradient background of control's tool tip ends with.

The end colour. The default is SystemColors.Info.

Used while the background style is DrawingStyle.Gradient and no built-in scheme is chosen. With the default angle of 270 degrees the end colour is at the top of the tip.

Gets the colour a gradient background of control's tool tip starts from.

The start colour. The default is SystemColors.Info.

Used while the background style is DrawingStyle.Gradient and no built-in scheme is chosen. With the default angle of 270 degrees the start colour is at the bottom of the tip.

Gets the background colour of control's tool tip when it is drawn solid.

The background colour. The default is SystemColors.Info.

Used while the background style is DrawingStyle.Solid, which is the style of a tip with no style or scheme set.

Gets whether the background of control's tool tip is a gradient or a solid colour.

DrawingStyle.Gradient whenever a built-in colour scheme is chosen; otherwise the style set, or DrawingStyle.Solid when none has been set.

A gradient runs from SetBinarySuperToolTipBackgroundDrawingGradientStartColor to SetBinarySuperToolTipBackgroundDrawingGradientEndColor at SetBinarySuperToolTipGradientDrawingOrientationAngle; a solid background is SetBinarySuperToolTipBackgroundDrawingSolidColor.

Set it to DrawingStyle.Gradient before choosing a built-in colour scheme, which is otherwise ignored. While a built-in scheme is in force the background is a gradient whatever is set here.

Gets the thickness of the line between the body and the footer of control's tool tip.

The thickness in pixels, from 1 to 3. The default is 1.

Gets the picture shown at the left of the body of control's tool tip.

The image, or null when there is none. The default is null.

The tip grows to fit the picture at its own size, up to half the width and height of the screen's working area. With SetBinarySuperToolTipUseCustomSizing on, a picture wider than about half the tip is scaled down to fit.

The image must be a Bitmap. Each time the tip is drawn, the pixels of SetBinarySuperToolTipBodyImageTransparencyColor are made see-through in the bitmap itself, so pass a copy if the same bitmap is used elsewhere.

Gets the colour made see-through in the body picture of control's tool tip.

The colour. The default is Color.Transparent, which leaves the picture as it is.

Gets the main text of control's tool tip.

The body text, or an empty string when the control has no tool tip or control is null.

Gets the font of the body text in control's tool tip.

The font set for the tip or, when none has been set, a new font in the family of MessageBoxFont at 10 points.

The tip is sized to fit its text in these fonts each time it opens.

Gets the colour of the body text in control's tool tip.

The text colour. The default is SystemColors.WindowText.

Ignored while a built-in colour scheme is chosen with SetBinarySuperToolTipBuiltInColorScheme: the scheme draws it in SystemColors.WindowText.

Gets the colour of the border round control's tool tip.

The border colour. The default is SystemColors.WindowText.

Ignored while a built-in colour scheme is chosen with SetBinarySuperToolTipBuiltInColorScheme: the scheme draws it in SystemColors.WindowText.

Gets the colour of the frame round the body picture of control's tool tip.

The frame colour. The default is SystemColors.WindowText.

The frame is drawn only while SetBinarySuperToolTipDrawBorderAroundBodyImage is on. Ignored while a built-in colour scheme is chosen with SetBinarySuperToolTipBuiltInColorScheme: the scheme draws it in SystemColors.WindowText.

Gets the built-in colour scheme control's tool tip is drawn in.

One of the ColorScheme values. The default is ColorScheme.Custom.

A built-in scheme fills the background with a gradient from the scheme's colour to the window colour, at SetBinarySuperToolTipGradientDrawingOrientationAngle, and draws all text, the border and the lines in SystemColors.WindowText; the colours set for the tip one by one are ignored while it is in force.

Set the background style to gradient first. While GetBinarySuperToolTipBackgroundDrawingStyle is DrawingStyle.Solid – as it is for a tip that has no scheme yet – a scheme set here is stored as ColorScheme.Custom and has no effect.

Gets the fixed size of control's tool tip.

The size, or Size.Empty when none has been set. The default is Size.Empty.

The size is used as given and is not scaled for the display. With a fixed size, a body picture wider than about half the tip is scaled down to fit.

Gets whether a border is drawn round control's tool tip.

true when the border is drawn. The default is true.

Gets whether a frame is drawn round the body picture of control's tool tip.

true when the frame is drawn. The default is false.

Gets whether the footer icon of control's tool tip is shown.

true when the icon is shown. The default is false.

The icon is shown only when the tip also has footer text.

Gets whether a line is drawn between the body and the footer of control's tool tip.

true when the line is drawn. The default is false.

The line is drawn only when the tip has footer text. Its colour is SetBinarySuperToolTipLineColorOnTopOfFooterArea and its thickness SetBinarySuperToolTipBodyFooterSeparatingLineDepth.

Gets whether the title icon of control's tool tip is shown.

true when the icon is shown. The default is false.

The icon is shown only when the tip also has title text.

Gets the icon shown beside the footer text of control's tool tip.

The icon, or null when there is none. The default is null.

Shown only while SetBinarySuperToolTipDrawFooterIcon is true and the tip has footer text. It is drawn 20 logical pixels square.

Gets the text at the foot of control's tool tip.

The footer text, or an empty string when there is none. The default is an empty string.

The footer is drawn in SetBinarySuperToolTipFooterTextFont and SetBinarySuperToolTipFooterTextForeColor, below an optional separating line (SetBinarySuperToolTipDrawLineSeparatingBodyAndFooterArea).

Gets the font of the footer text in control's tool tip.

The font set for the tip or, when none has been set, a new font in the family of MessageBoxFont at 10 points.

The tip is sized to fit its text in these fonts each time it opens.

Gets the colour of the footer text in control's tool tip.

The text colour. The default is SystemColors.WindowText.

Ignored while a built-in colour scheme is chosen with SetBinarySuperToolTipBuiltInColorScheme: the scheme draws it in SystemColors.WindowText.

Gets the direction of the gradient background of control's tool tip.

The angle in degrees, measured clockwise from left-to-right. The default is 270, which runs from the bottom of the tip up to the top.

Applies to both custom gradients and built-in colour schemes.

Gets the colour of the line between the body and the footer of control's tool tip.

The line colour. The default is SystemColors.WindowText.

The line is drawn only while SetBinarySuperToolTipDrawLineSeparatingBodyAndFooterArea is on and the tip has footer text. Ignored while a built-in colour scheme is chosen with SetBinarySuperToolTipBuiltInColorScheme: the scheme draws it in SystemColors.WindowText.

Gets the icon shown beside the title of control's tool tip.

The icon, or null when there is none. The default is null.

Shown only while SetBinarySuperToolTipDrawTitleIcon is true and the tip has title text. It is drawn 20 logical pixels square, at the top left of the tip.

Gets the heading at the top of control's tool tip.

The title, or an empty string when there is none. The default is an empty string.

The title is drawn in SetBinarySuperToolTipTitleTextFont and SetBinarySuperToolTipTitleTextForeColor. A tip with no title starts with its body.

Gets the font of the title text in control's tool tip.

The font set for the tip or, when none has been set, a new font in the family of MessageBoxFont at 10 points.

The tip is sized to fit its text in these fonts each time it opens. A bold font sets the title apart from the body.

Gets the colour of the title text in control's tool tip.

The text colour. The default is SystemColors.WindowText.

Ignored while a built-in colour scheme is chosen with SetBinarySuperToolTipBuiltInColorScheme: the scheme draws it in SystemColors.WindowText.

Gets whether control's tool tip has a fixed size rather than one fitted to its content.

true when the tip takes GetBinarySuperToolTipCustomSize. The default is false.

Without a fixed size the tip is measured to fit its content, up to half the width and half the height of the primary screen's working area. Set a custom size as well when turning this on – a tip with no custom size has no size at all.

Sets the colour a gradient background of control's tool tip ends with.

Used while the background style is DrawingStyle.Gradient and no built-in scheme is chosen. With the default angle of 270 degrees the end colour is at the top of the tip.

Sets the colour a gradient background of control's tool tip starts from.

Used while the background style is DrawingStyle.Gradient and no built-in scheme is chosen. With the default angle of 270 degrees the start colour is at the bottom of the tip.

tips.SetBinarySuperToolTipBackgroundDrawingStyle(exportButton, DrawingStyle.Gradient);
tips.SetBinarySuperToolTipBackgroundDrawingGradientStartColor(exportButton, Color.LightSteelBlue);
tips.SetBinarySuperToolTipBackgroundDrawingGradientEndColor(exportButton, Color.White);

Sets the background colour of control's tool tip when it is drawn solid.

Used while the background style is DrawingStyle.Solid, which is the style of a tip with no style or scheme set.

Sets whether the background of control's tool tip is a gradient or a solid colour.

A gradient runs from SetBinarySuperToolTipBackgroundDrawingGradientStartColor to SetBinarySuperToolTipBackgroundDrawingGradientEndColor at SetBinarySuperToolTipGradientDrawingOrientationAngle; a solid background is SetBinarySuperToolTipBackgroundDrawingSolidColor.

Set it to DrawingStyle.Gradient before choosing a built-in colour scheme, which is otherwise ignored. While a built-in scheme is in force the background is a gradient whatever is set here.

Sets the thickness of the line between the body and the footer of control's tool tip.

Sets a picture to show at the left of the body of control's tool tip, beside the body text – a preview, a chart or a screenshot of what the control does.

The tip grows to fit the picture at its own size, up to half the width and height of the screen's working area. With SetBinarySuperToolTipUseCustomSizing on, a picture wider than about half the tip is scaled down to fit.

The image must be a Bitmap. Each time the tip is drawn, the pixels of SetBinarySuperToolTipBodyImageTransparencyColor are made see-through in the bitmap itself, so pass a copy if the same bitmap is used elsewhere.

Sets the colour made see-through in the body picture of control's tool tip, so the tip's background shows through it.

Sets the main text of control's tool tip, and so turns the tip on for that control.

A control shows its tool tip only while it has body text: set the title, footer, icons and colours as well, but always set this. Use this method rather than the inherited ToolTip.SetToolTip, whose text this component does not draw.

When a handler is attached to HeaderDraw, BodyDraw or FooterDraw at the time of the call, the text is replaced by the placeholder "Being custom drawn.", on the expectation that the handlers draw the tip. Set the body text of tips you want drawn normally before attaching such handlers.

Passing null throws a NullReferenceException; pass an empty string to turn the tip off.

tips.SetBinarySuperToolTipTitleText(archiveButton, "Archive orders");
tips.SetBinarySuperToolTipBodyText(archiveButton,
    "Moves every order delivered more than 90 days ago to the archive." + Environment.NewLine +
    "Archived orders can still be searched, but not edited.");

Sets the font of the body text in control's tool tip.

The tip is sized to fit its text in these fonts each time it opens.

Sets the colour of the body text in control's tool tip.

Ignored while a built-in colour scheme is chosen with SetBinarySuperToolTipBuiltInColorScheme: the scheme draws it in SystemColors.WindowText.

Sets the colour of the border round control's tool tip.

Ignored while a built-in colour scheme is chosen with SetBinarySuperToolTipBuiltInColorScheme: the scheme draws it in SystemColors.WindowText.

Sets the colour of the frame round the body picture of control's tool tip.

The frame is drawn only while SetBinarySuperToolTipDrawBorderAroundBodyImage is on. Ignored while a built-in colour scheme is chosen with SetBinarySuperToolTipBuiltInColorScheme: the scheme draws it in SystemColors.WindowText.

Sets a built-in colour scheme for control's tool tip, in place of individual colours.

A built-in scheme fills the background with a gradient from the scheme's colour to the window colour, at SetBinarySuperToolTipGradientDrawingOrientationAngle, and draws all text, the border and the lines in SystemColors.WindowText; the colours set for the tip one by one are ignored while it is in force.

Set the background style to gradient first. While GetBinarySuperToolTipBackgroundDrawingStyle is DrawingStyle.Solid – as it is for a tip that has no scheme yet – a scheme set here is stored as ColorScheme.Custom and has no effect.

tips.SetBinarySuperToolTipBackgroundDrawingStyle(saveButton, DrawingStyle.Gradient);
tips.SetBinarySuperToolTipBuiltInColorScheme(saveButton, ColorScheme.Blue);

Sets a fixed size for control's tool tip, used while SetBinarySuperToolTipUseCustomSizing is on.

The size is used as given and is not scaled for the display. With a fixed size, a body picture wider than about half the tip is scaled down to fit.

Sets whether a border is drawn round control's tool tip.

Sets whether a one-pixel frame is drawn round the body picture of control's tool tip.

Sets whether the footer icon of control's tool tip is shown.

The icon is shown only when the tip also has footer text.

Sets whether a line is drawn between the body and the footer of control's tool tip.

The line is drawn only when the tip has footer text. Its colour is SetBinarySuperToolTipLineColorOnTopOfFooterArea and its thickness SetBinarySuperToolTipBodyFooterSeparatingLineDepth.

Sets whether the title icon of control's tool tip is shown.

The icon is shown only when the tip also has title text.

Sets the icon shown beside the footer text of control's tool tip – typically a help icon beside "Press F1 for more help".

Shown only while SetBinarySuperToolTipDrawFooterIcon is true and the tip has footer text. It is drawn 20 logical pixels square.

Sets the text at the foot of control's tool tip – a hint such as "Press F1 for more help" or a keyboard shortcut.

The footer is drawn in SetBinarySuperToolTipFooterTextFont and SetBinarySuperToolTipFooterTextForeColor, below an optional separating line (SetBinarySuperToolTipDrawLineSeparatingBodyAndFooterArea).

Sets the font of the footer text in control's tool tip.

The tip is sized to fit its text in these fonts each time it opens.

Sets the colour of the footer text in control's tool tip.

Ignored while a built-in colour scheme is chosen with SetBinarySuperToolTipBuiltInColorScheme: the scheme draws it in SystemColors.WindowText.

Sets the direction of the gradient background of control's tool tip.

Applies to both custom gradients and built-in colour schemes.

Sets the colour of the line between the body and the footer of control's tool tip.

The line is drawn only while SetBinarySuperToolTipDrawLineSeparatingBodyAndFooterArea is on and the tip has footer text. Ignored while a built-in colour scheme is chosen with SetBinarySuperToolTipBuiltInColorScheme: the scheme draws it in SystemColors.WindowText.

Sets the icon shown beside the title of control's tool tip.

Shown only while SetBinarySuperToolTipDrawTitleIcon is true and the tip has title text. It is drawn 20 logical pixels square, at the top left of the tip.

tips.SetBinarySuperToolTipTitleIcon(deleteButton, SystemIcons.Warning);
tips.SetBinarySuperToolTipDrawTitleIcon(deleteButton, true);

Sets the heading at the top of control's tool tip – usually the name of the command.

The title is drawn in SetBinarySuperToolTipTitleTextFont and SetBinarySuperToolTipTitleTextForeColor. A tip with no title starts with its body.

Sets the font of the title text in control's tool tip.

The tip is sized to fit its text in these fonts each time it opens. A bold font sets the title apart from the body.

tips.SetBinarySuperToolTipTitleTextFont(saveButton, new Font("Segoe UI", 10f, FontStyle.Bold));

Sets the colour of the title text in control's tool tip.

Ignored while a built-in colour scheme is chosen with SetBinarySuperToolTipBuiltInColorScheme: the scheme draws it in SystemColors.WindowText.

Sets whether control's tool tip has a fixed size rather than one fitted to its content.

Without a fixed size the tip is measured to fit its content, up to half the width and half the height of the primary screen's working area. Set a custom size as well when turning this on – a tip with no custom size has no size at all.

tips.SetBinarySuperToolTipCustomSize(chartButton, new Size(320, 200));
tips.SetBinarySuperToolTipUseCustomSizing(chartButton, true);

Occurs just before a tool tip opens, so it can be cancelled or brought up to date.

Raised for every control the component gives a tip. Set BinarySuperToolTipPopupEventArgs.CancelNow to keep the tip closed this time, or change the tip's title, footer and appearance for BinarySuperToolTipPopupEventArgs.AssociatedControl before it is measured and drawn.

tips.AboutToPopup += (sender, e) =>
{
    if (e.AssociatedControl == stockLabel)
    {
        tips.SetBinarySuperToolTipFooterText(stockLabel,
            "Stock checked at " + DateTime.Now.ToShortTimeString());
    }

    // No tips while the order is being saved.
    e.CancelNow = isSaving;
};

Occurs before the body of a tool tip is drawn, so it can be drawn by your own code instead.

Raised every time any of the component's tips is drawn. Draw with BinarySuperToolTipDrawingEventArgs.Graphics, check BinarySuperToolTipDrawingEventArgs.AssociatedControl to see whose tip it is, and set BinarySuperToolTipDrawingEventArgs.Handled to true for the tips you have drawn – leave it false and the component draws the body as usual.

The rectangle offered is the middle three fifths of the tip, below the title area.

tips.BodyDraw += (sender, e) =>
{
    if (e.AssociatedControl != salesChartButton)
    {
        return;
    }

    using (Brush bar = new SolidBrush(Color.SteelBlue))
    {
        float x = e.DrawingRectangle.X + 12;
        foreach (float share in new[] { 0.4f, 0.7f, 0.55f, 0.9f })
        {
            float height = (e.DrawingRectangle.Height - 12) * share;
            e.Graphics.FillRectangle(bar, x, e.DrawingRectangle.Bottom - 6 - height, 18, height);
            x += 26;
        }
    }

    e.Handled = true;
};

While any of the three drawing events has a handler, SetBinarySuperToolTipBodyText stores a placeholder instead of the text it is given, so attach handlers after setting body texts.

tips.BodyDraw += (sender, e) =>
{
    if (e.AssociatedControl != salesChartButton)
    {
        return;
    }

    using (Brush bar = new SolidBrush(Color.SteelBlue))
    {
        float x = e.DrawingRectangle.X + 12;
        foreach (float share in new[] { 0.4f, 0.7f, 0.55f, 0.9f })
        {
            float height = (e.DrawingRectangle.Height - 12) * share;
            e.Graphics.FillRectangle(bar, x, e.DrawingRectangle.Bottom - 6 - height, 18, height);
            x += 26;
        }
    }

    e.Handled = true;
};

Occurs before the footer of a tool tip is drawn, so it can be drawn by your own code instead.

Raised every time any of the component's tips is drawn. Draw with BinarySuperToolTipDrawingEventArgs.Graphics, check BinarySuperToolTipDrawingEventArgs.AssociatedControl to see whose tip it is, and set BinarySuperToolTipDrawingEventArgs.Handled to true for the tips you have drawn – leave it false and the component draws the footer as usual.

The rectangle offered is a fifth of the tip's height. Its top is placed one title-area height above the bottom of the tip only while HeaderDraw also has a handler; otherwise it starts at the bottom edge, so work out the footer area from the tip's size instead.

While any of the three drawing events has a handler, SetBinarySuperToolTipBodyText stores a placeholder instead of the text it is given, so attach handlers after setting body texts.

Occurs before the title area of a tool tip is drawn, so it can be drawn by your own code instead.

Raised every time any of the component's tips is drawn. Draw with BinarySuperToolTipDrawingEventArgs.Graphics, check BinarySuperToolTipDrawingEventArgs.AssociatedControl to see whose tip it is, and set BinarySuperToolTipDrawingEventArgs.Handled to true for the tips you have drawn – leave it false and the component draws the title area as usual.

The rectangle offered is the top fifth of the tip.

While any of the three drawing events has a handler, SetBinarySuperToolTipBodyText stores a placeholder instead of the text it is given, so attach handlers after setting body texts.