menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class CellSpanBackgroundInfo - API Reference

    Show / Hide Table of Contents

    Class CellSpanBackgroundInfo

    Holds the range and options for a cell span background. A cell span background tells the cells control to draw the background of one cell across multiple neighbouring cells. For example you can have a picture as background and this picture will be drawn across the neighbouring cells. These cells are still independent single cells, they only share the background.

    Inheritance
    System.Object
    CellSpanInfoBase
    CellSpanInfo
    CellSpanBackgroundInfo
    Implements
    System.IDisposable
    System.IComparable<CellSpanInfoBase>
    System.IComparable
    Inherited Members
    CellSpanInfo.ClipRows
    CellSpanInfo.ClipColumns
    CellSpanInfoBase.top
    CellSpanInfoBase.left
    CellSpanInfoBase.bottom
    CellSpanInfoBase.right
    CellSpanInfoBase.Contains(RowColumnIndex)
    CellSpanInfoBase.ContainsRow(Int32)
    CellSpanInfoBase.ContainsColumn(Int32)
    CellSpanInfoBase.Contains(Int32, Int32)
    CellSpanInfoBase.CompareTo(CellSpanInfoBase)
    CellSpanInfoBase.IComparable.CompareTo(Object)
    CellSpanInfoBase.Offset(Int32, Int32)
    CellSpanInfoBase.Offset(Int32, Int32, Boolean, Boolean)
    CellSpanInfoBase.Top
    CellSpanInfoBase.Left
    CellSpanInfoBase.Bottom
    CellSpanInfoBase.Right
    CellSpanInfoBase.Width
    CellSpanInfoBase.Height
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.Windows.Controls.Cells
    Assembly: Syncfusion.GridCommon.Wpf.dll
    Syntax
    public class CellSpanBackgroundInfo : CellSpanInfo, IDisposable, IComparable<CellSpanInfoBase>, IComparable

    Constructors

    CellSpanBackgroundInfo()

    Initializes a new instance of the CellSpanBackgroundInfo class.

    Declaration
    public CellSpanBackgroundInfo()

    CellSpanBackgroundInfo(Int32, Int32, Int32, Int32)

    Initializes a new instance of the CellSpanBackgroundInfo class.

    Declaration
    public CellSpanBackgroundInfo(int top, int left, int bottom, int right)
    Parameters
    Type Name Description
    System.Int32 top

    The top row index.

    System.Int32 left

    The left column index.

    System.Int32 bottom

    The bottom row index.

    System.Int32 right

    The right column index.

    CellSpanBackgroundInfo(Int32, Int32, Int32, Int32, Boolean, Boolean, Brush, Pen)

    Initializes a new instance of the CellSpanBackgroundInfo class.

    Declaration
    public CellSpanBackgroundInfo(int top, int left, int bottom, int right, bool clipRows, bool clipColumns, Brush background, Pen pen)
    Parameters
    Type Name Description
    System.Int32 top

    The top row index.

    System.Int32 left

    The left column index.

    System.Int32 bottom

    The bottom row index.

    System.Int32 right

    The right column index.

    System.Boolean clipRows

    if set to true allow estimates for out of view rows.

    System.Boolean clipColumns

    if set to true allow estimates for out of view columns.

    System.Windows.Media.Brush background

    The background.

    System.Windows.Media.Pen pen

    The pen.

    Properties

    Background

    Gets or sets the background.

    Declaration
    public Brush Background { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush

    The background.

    Border

    Gets or sets the border.

    Declaration
    public Pen Border { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Pen

    The border.

    Methods

    Dispose()

    Declaration
    public override void Dispose()
    Overrides
    CellSpanInfoBase.Dispose()

    Equals(Object)

    Determines whether the specified System.Object is equal to the current System.Object.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    System.Object obj

    The System.Object to compare with the current System.Object.

    Returns
    Type Description
    System.Boolean

    true if the specified System.Object is equal to the current System.Object; otherwise, false.

    Overrides
    CellSpanInfo.Equals(Object)

    GetHashCode()

    Serves as a hash function for a particular type.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32

    A hash code for the current System.Object.

    Overrides
    CellSpanInfo.GetHashCode()

    ToString()

    Returns a string describing the state of the object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    System.String
    Overrides
    CellSpanInfo.ToString()

    Implements

    System.IDisposable
    System.IComparable<T>
    System.IComparable
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved