Class ToolbarSettings

Represents ToolbarSettings class.

Inheritance

System.Object

ToolbarSettings

Namespace: Syncfusion.SfImageEditor.XForms

Assembly: Syncfusion.SfImageEditor.XForms.dll

Syntax

public class ToolbarSettings : Element, IThemeElement

Constructors

ToolbarSettings()

Initializes a new instance of the ToolbarSettings class.

Declaration

public ToolbarSettings()

Fields

BackgroundColorProperty

Gets or sets whether the toolbar needs to be visible or not. It is a bindable property.

Declaration

public static readonly BindableProperty BackgroundColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

BackToolbarItemProperty

Gets or sets the value for BackToolbarItem. It is a bindable property.

Declaration

public static readonly BindableProperty BackToolbarItemProperty

Field Value

Type
Xamarin.Forms.BindableProperty

BorderColorProperty

Gets or sets the toolbar border color. It is a bindable property.

Declaration

public static readonly BindableProperty BorderColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ColorPaletteCircleSizeProperty

Gets or sets the size to color palette circle in tool bar item. It is bindable property.

Declaration

public static readonly BindableProperty ColorPaletteCircleSizeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ColorPaletteItemSizeProperty

Gets or sets the size to color palette circle in tool bar item. It is bindable property.

Declaration

public static readonly BindableProperty ColorPaletteItemSizeProperty

Field Value

Type
Xamarin.Forms.BindableProperty

FooterToolbarHeightProperty

Gets or sets height of the footer toolbar.

Declaration

public static readonly BindableProperty FooterToolbarHeightProperty

Field Value

Type
Xamarin.Forms.BindableProperty

HeaderToolbarHeightProperty

Gets or sets height of the header toolbar.

Declaration

public static readonly BindableProperty HeaderToolbarHeightProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IsDeleteButtonVisibleProperty

Gets or sets whether the delete button to be visible or not. It is a bindable property.

Declaration

public static readonly BindableProperty IsDeleteButtonVisibleProperty

Field Value

Type
Xamarin.Forms.BindableProperty

IsVisibleProperty

Gets or sets whether the toolbar needs to be visible or not. It is a bindable property.

Declaration

public static readonly BindableProperty IsVisibleProperty

Field Value

Type
Xamarin.Forms.BindableProperty

SubItemToolbarHeightProperty

Gets or sets height of the SubItem toolbar.

Declaration

public static readonly BindableProperty SubItemToolbarHeightProperty

Field Value

Type
Xamarin.Forms.BindableProperty

TextColorProperty

Gets or sets whether the toolbar needs to be visible or not. It is a bindable property.

Declaration

public static readonly BindableProperty TextColorProperty

Field Value

Type
Xamarin.Forms.BindableProperty

ToolbarItemsProperty

Gets/sets toolbaritems collection value. It is a bindable property.

Declaration

public static readonly BindableProperty ToolbarItemsProperty

Field Value

Type
Xamarin.Forms.BindableProperty

VisibleShapesItemsProperty

Gets or sets whether the shape toolbar items to be visible or not. It is a bindable property.

Declaration

public static readonly BindableProperty VisibleShapesItemsProperty

Field Value

Type
Xamarin.Forms.BindableProperty

Properties

BackButton

Gets or sets BackButton of toolbar menu.

Declaration

public ToolbarItem BackButton { get; set; }

Property Value

Type
ToolbarItem

Examples

This sample shows how to set BackButton item.

Public MyPage()
{
    SfImageEditor imageEditor = new SfImageEditor();
    imageEditor.ToolbarSettings.BackButton.Text = "BackButton";
}

BackgroundColor

Gets or sets the toolbar background color. It is a bindable property.

Declaration

public Color BackgroundColor { get; set; }

Property Value

Type
Xamarin.Forms.Color

Examples

This sample shows how to set the BackgroundColor for the toolbar.

Public MyPage()
{
    SfImageEditor imageEditor = new SfImageEditor();
    imageEditor.ToolbarSettings.BackgroundColor = Color.Gray;
}

BorderColor

Gets or sets the toolbar border color. It is a bindable property.

Declaration

public Color BorderColor { get; set; }

Property Value

Type
Xamarin.Forms.Color

Examples

This sample shows how to set the BorderColor for the toolbar.

Public MyPage()
{
    SfImageEditor imageEditor = new SfImageEditor();
    imageEditor.ToolbarSettings.BorderColor = Color.Gray;
}

ColorPaletteCircleSize

Gets or sets the color palette size. This property is used to customize the size of color palette while editing the text, path, shape using toolbar items.

Declaration

public double ColorPaletteCircleSize { get; set; }

Property Value

Type
System.Double

ColorPaletteItemSize

Gets or sets the color palette size. This property is used to customize the size of color palette while editing the text, path, shape using toolbar items.

Declaration

public double ColorPaletteItemSize { get; set; }

Property Value

Type
System.Double

FooterToolbarHeight

Gets or sets Height of the footer toolbar.

Declaration

public double FooterToolbarHeight { get; set; }

Property Value

Type
System.Double

Examples

This sample shows how to set the height for the Footer toolbar.

Public MyPage()
{
    SfImageEditor imageEditor = new SfImageEditor();
    imageEditor.ToolbarSettings.FooterToolbarHeight = 70;
}

HeaderToolbarHeight

Gets or sets Height of the header toolbar.

Declaration

public double HeaderToolbarHeight { get; set; }

Property Value

Type
System.Double

Examples

This sample shows how to set the height for the Header toolbar.

Public MyPage()
{
    SfImageEditor imageEditor = new SfImageEditor();
    imageEditor.ToolbarSettings.HeaderToolbarHeight = 70;
}

IsDeleteButtonVisible

Gets or sets the visibility of delete button visibility for the selected shape.

Declaration

public bool IsDeleteButtonVisible { get; set; }

Property Value

Type
System.Boolean

Examples

This sample shows how to set the IsDeleteButtonVisible property for the delete button.

Public MyPage()
{
	SfImageEditor imageEditor = new SfImageEditor();
    imageEditor.ToolbarSettings.IsDeleteIconVisible = false;
}

IsVisible

Gets or sets whether the toolbar needs to be visible or not. It is a bindable property.

Declaration

public bool IsVisible { get; set; }

Property Value

Type
System.Boolean

Examples

This sample shows how to set the IsVisible property for the toolbar.

Public MyPage()
{
    SfImageEditor imageEditor = new SfImageEditor();
    imageEditor.ToolbarSettings.IsVisible = false;
}

SubItemToolbarHeight

Gets or sets Height of the SubItem toolbar.

Declaration

public double SubItemToolbarHeight { get; set; }

Property Value

Type
System.Double

Examples

This sample shows how to set the height for the SubItem toolbar.

Public MyPage()
{
    SfImageEditor imageEditor = new SfImageEditor();
    imageEditor.ToolbarSettings.SubItemToolbarHeight = 70;
}

TextColor

Gets or sets the background color of the toolbar. It is a bindable property.

Declaration

public Color TextColor { get; set; }

Property Value

Type
Xamarin.Forms.Color

Examples

This sample shows how to set the toolbar text color.

Public MyPage()
{
    SfImageEditor imageEditor = new SfImageEditor();
    imageEditor.ToolbarSettings.TextColor = Color.Gray;
}

ToolbarItems

Gets or sets collection of the toolbarItem value.

Declaration

public ObservableCollection<ToolbarItem> ToolbarItems { get; set; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<ToolbarItem>

Examples

This sample shows how to set the toolbaritem value.

Public MyPage()
{
    SfImageEditor imageEditor = new SfImageEditor();
    imageEditor.ToolbarSettings.ToolbarItems.Add(new HeaderToolbarItem() { });
}

VisibleShapesItems

Gets or sets the flagged enum visible shapes items in shape sub items such as rectangle, circle, arrow ,line, dotted, double arrow, dotted arrow, dotted double arrow.

Declaration

public ImageEditorShapes VisibleShapesItems { get; set; }

Property Value

Type
ImageEditorShapes

Examples

This sample shows how to set the VisibleShapesItems property for the shape toolbar items.

Public MyPage()
{
	SfImageEditor imageEditor = new SfImageEditor();
    imageEditor.ToolbarSettings.VisibleShapesItems = ImageEditorShapes.Line | ImageEditorShapes.DoubleArrow;
}

Methods

add_ToolbarItemSelected(ToolbarItemSelectedEventHandler)

Declaration

public void add_ToolbarItemSelected(ToolbarItemSelectedEventHandler value)

Parameters

Type	Name	Description
ToolbarItemSelectedEventHandler	value

remove_ToolbarItemSelected(ToolbarItemSelectedEventHandler)

Declaration

public void remove_ToolbarItemSelected(ToolbarItemSelectedEventHandler value)

Parameters

Type	Name	Description
ToolbarItemSelectedEventHandler	value

Events

ToolbarItemSelected

Represents ToolbarItemSelected event

Declaration

public event ToolbarItemSelectedEventHandler ToolbarItemSelected

Event Type

Type
ToolbarItemSelectedEventHandler