Class SpreadsheetHyperlinkCellRenderer
Represents a class which holds the cell renderer that displays the hyperlink in a cell. Override the methods for initializing content of the cell and arranging the cell visuals.
Inheritance
Inherited Members
Namespace: Syncfusion.UI.Xaml.Spreadsheet.CellRenderer
Assembly: Syncfusion.SfSpreadsheet.WPF.dll
Syntax
public class SpreadsheetHyperlinkCellRenderer : SpreadsheetVirtualizingCellRendererBase<ContentControl, TextBox>, ISpreadsheetCellRenderer, IDisposableConstructors
SpreadsheetHyperlinkCellRenderer()
Initializes a new instance of the SpreadsheetHyperlinkCellRenderer class.
Declaration
public SpreadsheetHyperlinkCellRenderer()Methods
cellRequestNavigate(CellRequestNavigateEventArgs)
Invoked to navigate through cells in different sheet.
Declaration
protected bool cellRequestNavigate(CellRequestNavigateEventArgs args)Parameters
| Type | Name | Description |
|---|---|---|
| CellRequestNavigateEventArgs | args | An CellRequestNavigateEventArgs that contains the event data. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True, if the cell navigates; else false |
GetControlValue()
Invoked to get the control value of the current cell .
Declaration
public override object GetControlValue()Returns
| Type | Description |
|---|---|
| System.Object | The value of the current cell. |
Overrides
OnEditElementLoaded(Object, RoutedEventArgs)
Occurs when edit UIElement is loaded into cell.
Declaration
protected override void OnEditElementLoaded(object sender, RoutedEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | The source of the event. |
| System.Windows.RoutedEventArgs | e | An System.Windows.RoutedEventArgs that contains the event data. |
Overrides
OnInitializeDisplayElement(RowColumnIndex, ContentControl, SpreadsheetColumn)
Invoked when display element is initialized on the cell.
Declaration
protected override void OnInitializeDisplayElement(RowColumnIndex rowColumnIndex, ContentControl uiElement, SpreadsheetColumn column)Parameters
| Type | Name | Description |
|---|---|---|
| RowColumnIndex | rowColumnIndex | Coordinates of a cell. |
| System.Windows.Controls.ContentControl | uiElement | An instance of System.Windows.Controls.ContentControl. |
| SpreadsheetColumn | column | An instance of SpreadsheetColumn. |
Overrides
OnInitializeEditElement(RowColumnIndex, TextBox, SpreadsheetColumn)
Invoked when the edit element is initialized on the cell
Declaration
protected override void OnInitializeEditElement(RowColumnIndex rowColumnIndex, TextBox uiElement, SpreadsheetColumn column)Parameters
| Type | Name | Description |
|---|---|---|
| RowColumnIndex | rowColumnIndex | Coordinates of a cell. |
| System.Windows.Controls.TextBox | uiElement | An instance of System.Windows.Controls.TextBox. |
| SpreadsheetColumn | column | An instance of SpreadsheetColumn. |
Overrides
OnSaveChanges()
Saves the modified text in the specified range.
Declaration
protected override void OnSaveChanges()Overrides
OnUnwireDisplayUIElement(ContentControl)
Unwire or unhook the events associated with the display UIElement.
Declaration
protected override void OnUnwireDisplayUIElement(ContentControl uiElement)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Controls.ContentControl | uiElement | An instance of System.Windows.Controls.ContentControl. |
Overrides
OnUnwireEditUIElement(TextBox)
Unwire or Unhook the events associated with edit UIElement.
Declaration
protected override void OnUnwireEditUIElement(TextBox uiElement)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Controls.TextBox | uiElement | An instance of System.Windows.Controls.TextBox. |
Overrides
OnUpdateCellStyle(RowColumnIndex, ContentControl, SpreadsheetColumn)
Update the cell style and content for display element.
Declaration
protected override void OnUpdateCellStyle(RowColumnIndex cellRowColumnIndex, ContentControl uiElement, SpreadsheetColumn column)Parameters
| Type | Name | Description |
|---|---|---|
| RowColumnIndex | cellRowColumnIndex | Coordinates of a cell. |
| System.Windows.Controls.ContentControl | uiElement | An instance of System.Windows.Controls.ContentControl. |
| SpreadsheetColumn | column | An instance of SpreadsheetColumn. |
Overrides
OnUpdateEditCellStyle(RowColumnIndex, TextBox, SpreadsheetColumn)
Update the cell style and content for edit element.
Declaration
protected override void OnUpdateEditCellStyle(RowColumnIndex cellRowColumnIndex, TextBox uiElement, SpreadsheetColumn column)Parameters
| Type | Name | Description |
|---|---|---|
| RowColumnIndex | cellRowColumnIndex | Coordinates of a cell. |
| System.Windows.Controls.TextBox | uiElement | An instance of System.Windows.Controls.TextBox. |
| SpreadsheetColumn | column | An instance of SpreadsheetColumn. |
Overrides
OnWireDisplayUIElement(ContentControl)
Wire or hook the events associated with the display UIElement.
Declaration
protected override void OnWireDisplayUIElement(ContentControl uiElement)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Controls.ContentControl | uiElement | An instance of System.Windows.Controls.ContentControl. |
Overrides
OnWireEditUIElement(TextBox)
Wire or hook the events associated with edit UIElement.
Declaration
protected override void OnWireEditUIElement(TextBox uiElement)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Controls.TextBox | uiElement | An instance of System.Windows.Controls.TextBox. |
Overrides
OpenHyperlink(Object, RoutedEventArgs)
Invoked when the hyperlink in the current cell is clicked.
Declaration
protected virtual void OpenHyperlink(object sender, RoutedEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | The source of the event. |
| System.Windows.RoutedEventArgs | e | An System.Windows.RoutedEventArgs that contains the event data. |
SetControlValue(Object)
Invoked to set the control value of the current cell.
Declaration
public override bool SetControlValue(object value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value | value of the current cell. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True or False. |
Overrides
TextInput(TextCompositionEventArgs)
Invoked when the input text is added in TextBox.
Declaration
protected override void TextInput(TextCompositionEventArgs args)Parameters
| Type | Name | Description |
|---|---|---|
| System.Windows.Input.TextCompositionEventArgs | args | An System.Windows.Input.TextCompositionEventArgs that contains the event data. |