4D v17
WP SET ATTRIBUTES
- 4D Write Pro Reference
-
- 4D Write Pro Language
-
- About 4D Write Pro objects
- Using commands from the Objects (Forms) theme
- Using commands from the Styled Text theme
- Accessing document contents by programming
- 4D Write Pro Constants
- WP Add picture
- WP CREATE BOOKMARK
- WP Create paragraph range
- WP Create picture range
- WP Create range
- WP Create table rangeNew
- WP DELETE BOOKMARK
- WP EXPORT DOCUMENT
- WP EXPORT VARIABLE
- WP GET ATTRIBUTES
- WP Get body
- WP Get bookmark range
- WP GET BOOKMARKS
- WP Get element by IDNew
- WP Get elementsNew
- WP Get footer
- WP Get frame
- WP Get header
- WP Get page count
- WP Get positionNew
- WP Get selection
- WP Get textNew
- WP Import document
- WP INSERT BREAKUpd
- WP INSERT DOCUMENT
- WP INSERT PICTURE
- WP Insert table
- WP Is font style supported
- WP New
- WP PRINT
- WP RESET ATTRIBUTES
- WP SELECT
- WP SET ATTRIBUTES
- WP SET FRAME
- WP SET TEXTNew
- WP Table append row
- WP Table get cellsUpd
- WP Table get columnsUpd
- WP Table get rowsUpd
- WP USE PAGE SETUP
- 4D Write Pro Attributes
WP SET ATTRIBUTES
| WP SET ATTRIBUTES ( targetObj ; attribName ; attribValue {; attribName2 ; attribValue2 ; ... ; attribNameN ; attribValueN} ) | ||||||||
| Parameter | Type | Description | ||||||
| targetObj | Object |
|
Range or element reference or 4D Write Pro document | |||||
| attribName | Text |
|
Name of attribute to set | |||||
| attribValue | Text, Number, Longint array, Real array, Picture, Date |
|
New attribute value | |||||
The WP SET ATTRIBUTES command allows you to set the value of any attribute in a range, element reference or document. This command gives you access to any kind of 4D Write Pro internal attribute: character, paragraph, document, table, or image.
In the first parameter, you can pass :
- a range, or
- an element reference (header / footer / body / table / row / paragraph / anchored or inline picture), or
- a 4D Write Pro document
In attribName, pass the name of the attribute to set for the target and in attribValue, pass the new value to set. For a comprehensive list of attributes to pass in attribName, as well as their scope and respective values, please refer to the 4D Write Pro Attributes section.
You can pass as many attribName / attribValue pairs as you want.
Note: If you need to set multiple attributes for the same target, it is more optimized to use a single call to WP SET ATTRIBUTES with all attribute/value pairs, rather than calling WP SET ATTRIBUTES several times.
In this 4D Write Pro area, you selected a word:
If you execute the following code:
$range:=WP Get selection(*;"WParea") //get the selected range
// set the shadow offset in pt for the selected text
WP SET ATTRIBUTES($range;wk text shadow offset;1)
//set the paragraph padding
WP SET ATTRIBUTES($range;wk padding;1)
//define a border of 10 pt
WP SET ATTRIBUTES($range;wk border style;wk solid;wk border width;10)
//set the border colors
WP SET ATTRIBUTES($range;wk border color;"blue";wk border color bottom;"#00FA9A";wk border color right;"#00FA9A")You get the following result:
This example illustrates the use of wk inside and wk outside constants:
$wpRange:=WP Get selection(writeProdoc)
WP SET ATTRIBUTES($wpRange;wk border style+wk inside;wk dotted)
WP SET ATTRIBUTES($wpRange;wk border style+wk outside;wk solid)
WP SET ATTRIBUTES($wpRange;wk border color+wk outside;"#00FA9A")Assuming all of the contents were selected, the result is:
You want to set a background image for the document:
C_OBJECT(WParea)
WParea:=WP New
READ PICTURE FILE("C:\\Pictures\\boats.jpg";$picture)
WP SET ATTRIBUTES(WParea;wk background image;$picture)The result is:
You want to set a background image that covers the whole printable area:
C_OBJECT(WParea)
WParea:=WP New
READ PICTURE FILE("C:\\Pictures\\boats.jpg";$picture)
WP SET ATTRIBUTES(WParea;wk background image;$picture)
WP SET ATTRIBUTES(WParea;wk background clip;wk paper box)
WP SET ATTRIBUTES(WParea;wk background origin;wk paper box)The result is:
Note: The paper box value is only applicable to documents and sections.
You want to set tabs at varying intervals and designate different characters as the leading character:
C_OBJECT(WParea)
ARRAY TEXT(_position;0)
ARRAY LONGINT(_type;0)
ARRAY TEXT(_leadings;0)
APPEND TO ARRAY(_position;"3cm")
APPEND TO ARRAY(_type;wk left)
APPEND TO ARRAY(_leadings;".")
APPEND TO ARRAY(_position;"7.5cm")
APPEND TO ARRAY(_type;wk right)
APPEND TO ARRAY(_leadings;".")
APPEND TO ARRAY(_position;"9cm")
APPEND TO ARRAY(_type;wk center)
APPEND TO ARRAY(_leadings;".")
APPEND TO ARRAY(_position;"12cm")
APPEND TO ARRAY(_type;wk decimal)
APPEND TO ARRAY(_leadings;"~")
APPEND TO ARRAY(_position;"2cm")
APPEND TO ARRAY(_type;wk left)
APPEND TO ARRAY(_leadings;"")
$range:=WP Get selection(WParea)
WP SET ATTRIBUTES($range;wk tab stop offsets;_position)
WP SET ATTRIBUTES($range;wk tab stop types;_type)
WP SET ATTRIBUTES($range;wk tab stop leadings;_leadings)The result is:
4D Write Pro Attributes
WP GET ATTRIBUTES
WP RESET ATTRIBUTES
Product: 4D
Theme: 4D Write Pro Language
Number:
1342
Created: 4D v15 R4
Modified: 4D v16 R4
Modified: 4D v16 R6
4D Write Pro Reference ( 4D v17)
