Search Results for

    Show / Hide Table of Contents

    Class BasicSegmentEditControl

    An edit control providing display and editing functionalities for bilingual content. This control is restricted to displaying only one segment. The contents of the segment should be created using the provided ItemFactory. This control is read-only by default.

    Inheritance
    object
    MarshalByRefObject
    Component
    Control
    ScrollableControl
    ContainerControl
    UserControl
    BasicSegmentEditControl
    Implements
    IDropTarget
    ISynchronizeInvoke
    IWin32Window
    IBindableComponent
    IComponent
    IDisposable
    IContainerControl
    Inherited Members
    UserControl.ValidateChildren()
    UserControl.ValidateChildren(ValidationConstraints)
    UserControl.OnCreateControl()
    UserControl.OnLoad(EventArgs)
    UserControl.OnResize(EventArgs)
    UserControl.OnMouseDown(MouseEventArgs)
    UserControl.WndProc(ref Message)
    UserControl.AutoSize
    UserControl.AutoSizeMode
    UserControl.AutoValidate
    UserControl.BorderStyle
    UserControl.CreateParams
    UserControl.DefaultSize
    UserControl.AutoSizeChanged
    UserControl.AutoValidateChanged
    UserControl.Load
    ContainerControl.AdjustFormScrollbars(bool)
    ContainerControl.OnAutoValidateChanged(EventArgs)
    ContainerControl.OnFontChanged(EventArgs)
    ContainerControl.OnLayout(LayoutEventArgs)
    ContainerControl.OnParentChanged(EventArgs)
    ContainerControl.PerformAutoScale()
    ContainerControl.ProcessDialogChar(char)
    ContainerControl.ProcessDialogKey(Keys)
    ContainerControl.ProcessCmdKey(ref Message, Keys)
    ContainerControl.ProcessMnemonic(char)
    ContainerControl.ProcessTabKey(bool)
    ContainerControl.Select(bool, bool)
    ContainerControl.UpdateDefaultButton()
    ContainerControl.Validate()
    ContainerControl.Validate(bool)
    ContainerControl.AutoScaleDimensions
    ContainerControl.AutoScaleFactor
    ContainerControl.AutoScaleMode
    ContainerControl.BindingContext
    ContainerControl.CanEnableIme
    ContainerControl.ActiveControl
    ContainerControl.CurrentAutoScaleDimensions
    ContainerControl.ParentForm
    ScrollableControl.ScrollStateAutoScrolling
    ScrollableControl.ScrollStateHScrollVisible
    ScrollableControl.ScrollStateVScrollVisible
    ScrollableControl.ScrollStateUserHasScrolled
    ScrollableControl.ScrollStateFullDrag
    ScrollableControl.GetScrollState(int)
    ScrollableControl.OnMouseWheel(MouseEventArgs)
    ScrollableControl.OnRightToLeftChanged(EventArgs)
    ScrollableControl.OnPaintBackground(PaintEventArgs)
    ScrollableControl.OnPaddingChanged(EventArgs)
    ScrollableControl.OnVisibleChanged(EventArgs)
    ScrollableControl.ScaleControl(SizeF, BoundsSpecified)
    ScrollableControl.SetDisplayRectLocation(int, int)
    ScrollableControl.ScrollControlIntoView(Control)
    ScrollableControl.ScrollToControl(Control)
    ScrollableControl.OnScroll(ScrollEventArgs)
    ScrollableControl.SetAutoScrollMargin(int, int)
    ScrollableControl.SetScrollState(int, bool)
    ScrollableControl.AutoScroll
    ScrollableControl.AutoScrollMargin
    ScrollableControl.AutoScrollPosition
    ScrollableControl.AutoScrollMinSize
    ScrollableControl.DisplayRectangle
    ScrollableControl.HScroll
    ScrollableControl.HorizontalScroll
    ScrollableControl.VScroll
    ScrollableControl.VerticalScroll
    ScrollableControl.Scroll
    Control.GetAccessibilityObjectById(int)
    Control.SetAutoSizeMode(AutoSizeMode)
    Control.GetAutoSizeMode()
    Control.GetPreferredSize(Size)
    Control.AccessibilityNotifyClients(AccessibleEvents, int)
    Control.AccessibilityNotifyClients(AccessibleEvents, int, int)
    Control.BeginInvoke(Delegate)
    Control.BeginInvoke(Delegate, params object[])
    Control.BringToFront()
    Control.Contains(Control)
    Control.CreateAccessibilityInstance()
    Control.CreateControlsInstance()
    Control.CreateGraphics()
    Control.CreateHandle()
    Control.CreateControl()
    Control.DefWndProc(ref Message)
    Control.DestroyHandle()
    Control.DoDragDrop(object, DragDropEffects)
    Control.DrawToBitmap(Bitmap, Rectangle)
    Control.EndInvoke(IAsyncResult)
    Control.FindForm()
    Control.GetTopLevel()
    Control.RaiseKeyEvent(object, KeyEventArgs)
    Control.RaiseMouseEvent(object, MouseEventArgs)
    Control.Focus()
    Control.FromChildHandle(IntPtr)
    Control.FromHandle(IntPtr)
    Control.GetChildAtPoint(Point, GetChildAtPointSkip)
    Control.GetChildAtPoint(Point)
    Control.GetContainerControl()
    Control.GetScaledBounds(Rectangle, SizeF, BoundsSpecified)
    Control.GetNextControl(Control, bool)
    Control.GetStyle(ControlStyles)
    Control.Hide()
    Control.InitLayout()
    Control.Invalidate(Region)
    Control.Invalidate(Region, bool)
    Control.Invalidate()
    Control.Invalidate(bool)
    Control.Invalidate(Rectangle)
    Control.Invalidate(Rectangle, bool)
    Control.Invoke(Delegate)
    Control.Invoke(Delegate, params object[])
    Control.InvokePaint(Control, PaintEventArgs)
    Control.InvokePaintBackground(Control, PaintEventArgs)
    Control.IsKeyLocked(Keys)
    Control.IsInputChar(char)
    Control.IsInputKey(Keys)
    Control.IsMnemonic(char, string)
    Control.LogicalToDeviceUnits(int)
    Control.LogicalToDeviceUnits(Size)
    Control.ScaleBitmapLogicalToDevice(ref Bitmap)
    Control.NotifyInvalidate(Rectangle)
    Control.InvokeOnClick(Control, EventArgs)
    Control.OnAutoSizeChanged(EventArgs)
    Control.OnBackColorChanged(EventArgs)
    Control.OnBackgroundImageChanged(EventArgs)
    Control.OnBackgroundImageLayoutChanged(EventArgs)
    Control.OnBindingContextChanged(EventArgs)
    Control.OnCausesValidationChanged(EventArgs)
    Control.OnContextMenuChanged(EventArgs)
    Control.OnContextMenuStripChanged(EventArgs)
    Control.OnCursorChanged(EventArgs)
    Control.OnDockChanged(EventArgs)
    Control.OnEnabledChanged(EventArgs)
    Control.OnForeColorChanged(EventArgs)
    Control.OnNotifyMessage(Message)
    Control.OnParentBackColorChanged(EventArgs)
    Control.OnParentBackgroundImageChanged(EventArgs)
    Control.OnParentBindingContextChanged(EventArgs)
    Control.OnParentCursorChanged(EventArgs)
    Control.OnParentEnabledChanged(EventArgs)
    Control.OnParentFontChanged(EventArgs)
    Control.OnParentForeColorChanged(EventArgs)
    Control.OnParentRightToLeftChanged(EventArgs)
    Control.OnParentVisibleChanged(EventArgs)
    Control.OnPrint(PaintEventArgs)
    Control.OnTabIndexChanged(EventArgs)
    Control.OnTabStopChanged(EventArgs)
    Control.OnTextChanged(EventArgs)
    Control.OnClick(EventArgs)
    Control.OnClientSizeChanged(EventArgs)
    Control.OnControlAdded(ControlEventArgs)
    Control.OnControlRemoved(ControlEventArgs)
    Control.OnHandleCreated(EventArgs)
    Control.OnLocationChanged(EventArgs)
    Control.OnHandleDestroyed(EventArgs)
    Control.OnDoubleClick(EventArgs)
    Control.OnDragEnter(DragEventArgs)
    Control.OnDragOver(DragEventArgs)
    Control.OnDragLeave(EventArgs)
    Control.OnDragDrop(DragEventArgs)
    Control.OnGiveFeedback(GiveFeedbackEventArgs)
    Control.OnEnter(EventArgs)
    Control.InvokeGotFocus(Control, EventArgs)
    Control.OnGotFocus(EventArgs)
    Control.OnHelpRequested(HelpEventArgs)
    Control.OnInvalidated(InvalidateEventArgs)
    Control.OnKeyDown(KeyEventArgs)
    Control.OnKeyPress(KeyPressEventArgs)
    Control.OnKeyUp(KeyEventArgs)
    Control.OnLeave(EventArgs)
    Control.InvokeLostFocus(Control, EventArgs)
    Control.OnLostFocus(EventArgs)
    Control.OnMarginChanged(EventArgs)
    Control.OnMouseDoubleClick(MouseEventArgs)
    Control.OnMouseClick(MouseEventArgs)
    Control.OnMouseCaptureChanged(EventArgs)
    Control.OnMouseEnter(EventArgs)
    Control.OnMouseLeave(EventArgs)
    Control.OnDpiChangedBeforeParent(EventArgs)
    Control.OnDpiChangedAfterParent(EventArgs)
    Control.OnMouseHover(EventArgs)
    Control.OnMouseMove(MouseEventArgs)
    Control.OnMouseUp(MouseEventArgs)
    Control.OnMove(EventArgs)
    Control.OnPaint(PaintEventArgs)
    Control.OnQueryContinueDrag(QueryContinueDragEventArgs)
    Control.OnRegionChanged(EventArgs)
    Control.OnPreviewKeyDown(PreviewKeyDownEventArgs)
    Control.OnSizeChanged(EventArgs)
    Control.OnChangeUICues(UICuesEventArgs)
    Control.OnStyleChanged(EventArgs)
    Control.OnSystemColorsChanged(EventArgs)
    Control.OnValidating(CancelEventArgs)
    Control.OnValidated(EventArgs)
    Control.RescaleConstantsForDpi(int, int)
    Control.PerformLayout()
    Control.PerformLayout(Control, string)
    Control.PointToClient(Point)
    Control.PointToScreen(Point)
    Control.PreProcessMessage(ref Message)
    Control.PreProcessControlMessage(ref Message)
    Control.ProcessKeyEventArgs(ref Message)
    Control.ProcessKeyMessage(ref Message)
    Control.ProcessKeyPreview(ref Message)
    Control.RaiseDragEvent(object, DragEventArgs)
    Control.RaisePaintEvent(object, PaintEventArgs)
    Control.RecreateHandle()
    Control.RectangleToClient(Rectangle)
    Control.RectangleToScreen(Rectangle)
    Control.ReflectMessage(IntPtr, ref Message)
    Control.Refresh()
    Control.ResetMouseEventArgs()
    Control.ResetText()
    Control.ResumeLayout()
    Control.ResumeLayout(bool)
    Control.Scale(SizeF)
    Control.Select()
    Control.SelectNextControl(Control, bool, bool, bool, bool)
    Control.SendToBack()
    Control.SetBounds(int, int, int, int)
    Control.SetBounds(int, int, int, int, BoundsSpecified)
    Control.SetBoundsCore(int, int, int, int, BoundsSpecified)
    Control.SetClientSizeCore(int, int)
    Control.SizeFromClientSize(Size)
    Control.SetStyle(ControlStyles, bool)
    Control.SetTopLevel(bool)
    Control.SetVisibleCore(bool)
    Control.RtlTranslateAlignment(HorizontalAlignment)
    Control.RtlTranslateAlignment(LeftRightAlignment)
    Control.RtlTranslateAlignment(ContentAlignment)
    Control.RtlTranslateHorizontal(HorizontalAlignment)
    Control.RtlTranslateLeftRight(LeftRightAlignment)
    Control.RtlTranslateContent(ContentAlignment)
    Control.Show()
    Control.SuspendLayout()
    Control.Update()
    Control.UpdateBounds()
    Control.UpdateBounds(int, int, int, int)
    Control.UpdateBounds(int, int, int, int, int, int)
    Control.UpdateZOrder()
    Control.UpdateStyles()
    Control.OnImeModeChanged(EventArgs)
    Control.AccessibilityObject
    Control.AccessibleDefaultActionDescription
    Control.AccessibleDescription
    Control.AccessibleName
    Control.AccessibleRole
    Control.AllowDrop
    Control.Anchor
    Control.AutoScrollOffset
    Control.LayoutEngine
    Control.BackColor
    Control.BackgroundImage
    Control.BackgroundImageLayout
    Control.Bottom
    Control.Bounds
    Control.CanFocus
    Control.CanRaiseEvents
    Control.CanSelect
    Control.Capture
    Control.CausesValidation
    Control.CheckForIllegalCrossThreadCalls
    Control.ClientRectangle
    Control.ClientSize
    Control.CompanyName
    Control.ContainsFocus
    Control.ContextMenu
    Control.ContextMenuStrip
    Control.Controls
    Control.Created
    Control.Cursor
    Control.DataBindings
    Control.DefaultBackColor
    Control.DefaultCursor
    Control.DefaultFont
    Control.DefaultForeColor
    Control.DefaultMargin
    Control.DefaultMaximumSize
    Control.DefaultMinimumSize
    Control.DefaultPadding
    Control.DeviceDpi
    Control.IsDisposed
    Control.Disposing
    Control.Dock
    Control.DoubleBuffered
    Control.Enabled
    Control.Focused
    Control.Font
    Control.FontHeight
    Control.ForeColor
    Control.Handle
    Control.HasChildren
    Control.Height
    Control.IsHandleCreated
    Control.InvokeRequired
    Control.IsAccessible
    Control.IsMirrored
    Control.Left
    Control.Location
    Control.Margin
    Control.MaximumSize
    Control.MinimumSize
    Control.ModifierKeys
    Control.MouseButtons
    Control.MousePosition
    Control.Name
    Control.Parent
    Control.ProductName
    Control.ProductVersion
    Control.RecreatingHandle
    Control.Region
    Control.RenderRightToLeft
    Control.ResizeRedraw
    Control.Right
    Control.RightToLeft
    Control.ScaleChildren
    Control.Site
    Control.Size
    Control.TabIndex
    Control.TabStop
    Control.Tag
    Control.Text
    Control.Top
    Control.TopLevelControl
    Control.ShowKeyboardCues
    Control.ShowFocusCues
    Control.UseWaitCursor
    Control.Visible
    Control.Width
    Control.PreferredSize
    Control.Padding
    Control.DefaultImeMode
    Control.ImeMode
    Control.ImeModeBase
    Control.PropagatingImeMode
    Control.BackColorChanged
    Control.BackgroundImageChanged
    Control.BackgroundImageLayoutChanged
    Control.BindingContextChanged
    Control.CausesValidationChanged
    Control.ClientSizeChanged
    Control.ContextMenuChanged
    Control.ContextMenuStripChanged
    Control.CursorChanged
    Control.DockChanged
    Control.EnabledChanged
    Control.FontChanged
    Control.ForeColorChanged
    Control.LocationChanged
    Control.MarginChanged
    Control.RegionChanged
    Control.RightToLeftChanged
    Control.SizeChanged
    Control.TabIndexChanged
    Control.TabStopChanged
    Control.TextChanged
    Control.VisibleChanged
    Control.Click
    Control.ControlAdded
    Control.ControlRemoved
    Control.DragDrop
    Control.DragEnter
    Control.DragOver
    Control.DragLeave
    Control.GiveFeedback
    Control.HandleCreated
    Control.HandleDestroyed
    Control.HelpRequested
    Control.Invalidated
    Control.PaddingChanged
    Control.Paint
    Control.QueryContinueDrag
    Control.QueryAccessibilityHelp
    Control.DoubleClick
    Control.Enter
    Control.GotFocus
    Control.KeyDown
    Control.KeyPress
    Control.KeyUp
    Control.Layout
    Control.Leave
    Control.LostFocus
    Control.MouseClick
    Control.MouseDoubleClick
    Control.MouseCaptureChanged
    Control.MouseDown
    Control.MouseEnter
    Control.MouseLeave
    Control.DpiChangedBeforeParent
    Control.DpiChangedAfterParent
    Control.MouseHover
    Control.MouseMove
    Control.MouseUp
    Control.MouseWheel
    Control.Move
    Control.PreviewKeyDown
    Control.Resize
    Control.ChangeUICues
    Control.StyleChanged
    Control.SystemColorsChanged
    Control.Validating
    Control.Validated
    Control.ParentChanged
    Control.ImeModeChanged
    Component.Dispose()
    Component.GetService(Type)
    Component.ToString()
    Component.Events
    Component.Container
    Component.DesignMode
    Component.Disposed
    MarshalByRefObject.MemberwiseClone(bool)
    MarshalByRefObject.GetLifetimeService()
    MarshalByRefObject.InitializeLifetimeService()
    MarshalByRefObject.CreateObjRef(Type)
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Sdl.DesktopEditor.BasicControls
    Assembly: Sdl.DesktopEditor.BasicControls.dll
    Syntax
    public class BasicSegmentEditControl : UserControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl

    Constructors

    BasicSegmentEditControl()

    Default constructor, display settings are initialized to defaults.

    Declaration
    public BasicSegmentEditControl()

    Properties

    IsReadOnly

    Determines whether the control is read-only or not. Default is true.

    Declaration
    public bool IsReadOnly { get; set; }
    Property Value
    Type Description
    bool

    ItemFactory

    The item factory to use when creating content to display in the control.

    Declaration
    public IDocumentItemFactory ItemFactory { get; }
    Property Value
    Type Description
    IDocumentItemFactory

    Methods

    Dispose(bool)

    Clean up any resources being used.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    bool disposing

    true if managed resources should be disposed; otherwise, false.

    Overrides
    ContainerControl.Dispose(bool)

    GetDocumentSegment()

    Provides access to the current document segment as it is in the edit control.

    Declaration
    public ISegment GetDocumentSegment()
    Returns
    Type Description
    ISegment

    The segment used by the control.

    MoveSelection(TextLocation, TextLocation)

    Moves the edit control's text selection to the locations provided.

    Declaration
    public void MoveSelection(TextLocation fromLocation, TextLocation uptoLocation)
    Parameters
    Type Name Description
    TextLocation fromLocation

    The starting point of the selection.

    TextLocation uptoLocation

    The finishing point of the selection.

    RedrawControl()

    Forces a redraw of the control.

    Declaration
    public void RedrawControl()

    ReplaceDocumentSegment(ISegment)

    Replaces the document in the control with the content of the segment.

    Declaration
    public void ReplaceDocumentSegment(ISegment segment)
    Parameters
    Type Name Description
    ISegment segment

    The segment containing the content to replace.

    Events

    SegmentContentChanged

    Event fired when the content of the segment in the control has been manually modified

    Declaration
    public event EventHandler SegmentContentChanged
    Event Type
    Type Description
    EventHandler

    Implements

    IDropTarget
    ISynchronizeInvoke
    IWin32Window
    IBindableComponent
    IComponent
    IDisposable
    IContainerControl

    Extension Methods

    WindowsControlUtils.ForWindowFromFrameworkElement(object, Action<Window>)
    In this article
    • Constructors
      • BasicSegmentEditControl()
    • Properties
      • IsReadOnly
      • ItemFactory
    • Methods
      • Dispose(bool)
      • GetDocumentSegment()
      • MoveSelection(TextLocation, TextLocation)
      • RedrawControl()
      • ReplaceDocumentSegment(ISegment)
    • Events
      • SegmentContentChanged
    • Implements
    • Extension Methods
    Back to top Generated by DocFX