diff --git a/docs/xml/lcl/clipbrd.xml b/docs/xml/lcl/clipbrd.xml index 8c7006a085..64c064be9a 100644 --- a/docs/xml/lcl/clipbrd.xml +++ b/docs/xml/lcl/clipbrd.xml @@ -475,10 +475,60 @@ TComponent instance which is the parent for the component on the clipboard. - -GetComponentAsText - read the component as text, if supported. +Loads a component instance from a textual representation stored in the +clipboard. + + +

+GetComponentAsText creates a temporary TMemoryStream used to load +the pcfText clipboard content returned by AsText. ReadComponentFromTextStream +(in lresources.pp) is called to get the component class reference +needed to instantiate and load the component in RootComponent. Owner +and Parent contain the values stored to the corresponding properties +in the newly created component instance. +

+

+Use GetComponent to create and load a component instance from a pcfComponent +format stored in the clipboard. +

+

+Use SetComponentAsText and SetComponent to store a component instance to the +clipboard using with the pcfText or pcfComponent format. +

+

+Use SupportedFormats to determine which storage formats are supported in the +clipboard. +

+
+ + + + + +ReadComponentFromTextStream + +
+ + +Variable argument where the component loaded from the clipboard is stored. + + + + +Routine used to the locate the component class reference need to create a new +component instance. + + + + +Owner of the newly created component instance. + + + + +Parent for the newly created component instance.