Article Object
Contents
The Article object provides control over current article.
The Article object is available in Ted and in Fred. Some methods and properties of the Article object are available in Fred only during text editing.
Methods and properties
| ApplyArticleTemplate Method | Applies a template article to the current article. |
| Attr Property | Returns the attribute object of the article. |
| CanInsObj Method | Returns true if it is possible to insert an object of the specified type in the article at the specified position. |
| CloseTxt Method | Terminates the editing of the specified text. |
| DelCurNode Method | Delete the current node (element) in the article tree window. |
| DelTxt Method | Deletes the specified text from the article. |
| DerivedDlg Method | Displays a dialog which lists all the articles copied to or from the current one |
| DoFindRepl Method | Displays a dialog to find and replace in an article |
| Find Method | Searches the current text for a string. |
| FindNext Method | Searches for the next match after a previous find command. |
| FindReplace Method | In the current text replaces str1 with str2, using options, specified in str3. |
| FolderId Property | Returns or set the database id of the folder the article is in. |
| ForgetImageAssigns Method | Clears the cache of the last used picture. |
| GetCurNode Method | Returns a node object corresponding to the element of the article that is selected in the tree window. |
| GetCurTxtIdx Method | Returns the index of the current text. |
| GetRefObj Method | Return a reference object corresponding to the picture, multi-media or URL referenced by the specified text. |
| GetRootNode Method | Return a node object corresponding to the root element of the article - i.e. the whole article. |
| GetSpellErrorNum Method | Return the number of spell checking errors in the article. |
| GetSpotList Method | Returns the list of spot colors in the system, delimited by "|". |
| GetTxt Method | Return the text object of the nIdx text in the article. |
| GetTxtNode Method | Returns a node object corresponding to the specified text. |
| GotoNode Method | Edits the text of the specified node. |
| GotoNodeEx Method | Edits the text of the specified node in the specified mode. |
| GotoTxt Method | Edits the text of the specified node. |
| GotoTxtEx Method | Edits the specified text in the specified mode |
| HasChangedText Method | Returns true if at least one of the article elements has unsaved changes. |
| HasLocalGeometry Method | Returns true if at least one of the article elements has a local geometry |
| HasRefObj Method | Returns true if the specified text references an object (picture, multi-media or URL). |
| Id Property | Returns the database identifier of the article. |
| InsChildNode Method | Insert a new child of the currently selected node. |
| InsNewTxt Method | Inserts a newly created text at the specified position in the article. |
| InsNodeAtCur Method | Insert a new node before or after the current one. |
| InsObj Method | Inserts the object (picture etc.) of the specified type and id in the article at the specified position. |
| InsObjDlg Method | Display a dialog and inserts an object (picture, multi-media elements etc.) |
| InsTxt Method | Inserts an existing text at the specified position in the article. |
| InsTxtDlg Method | Display dialog to select and insert an existing text at the specified position in the article. |
| IsChanged Property | Returns true if the article has been modified and not saved yet. |
| IsChecked Property | Returns true if the article is checked-out. |
| IsNewProperty | Returns true if the article has not yet been saved in the database. |
| LinkSelected Method | Links all the selected frames and pictures to the article. |
| MakeNew Method | Prompts the user to open an existing article and then converts it into a new one. |
| MergeFromArticle Method | Appends the data of an existing article into the current one. |
| MergeFromArticleEx Method | Appends the content of an existing article into the current one on the specified position (on the end or on the beginning). |
| Name Method | Returns or set the name of the article. |
| NTxts Property | Returns the number of texts contained in the article. |
| PDFGenerate Method | Generates PDF directly from Ted and returns the error code. |
| PictureFolderId Method | Returns or set the database id of the folder the picture is in. |
| PrintDraft Method | Prints the entire article in draft mode. |
| Refresh Method | Reloads the article from the database. |
| RefreshGeometry Method | Reloads the geometry of all the article's text from the database. |
| Save Method | Saves the article. |
| SaveAs Method | Saves the article programmatically to a new copy with given name in given folder, without any prompt/dialog box. |
| SaveDlg Method | Displays a dialog box to save the article |
| SaveTexts Method | Saves all article elements at once. |
| SelNode Method | Selects the specified node (element) in the article tree window. |
| SetReferenceDlg Method | Prompts the user to select a different referenced object (picture, multi-media or URL) for the specified text. |
| SetReferenceId Method | Replaces a referenced object with a specified one (by id). |
| SpellCheck Method | Checks spelling the entire article in the specified language. |
| SpellCheckDlg Method | Checks spelling in the entire article showing the dialog to choose the language. |
| Spike Method | Spikes the article, closing its window. |
| Status Property | Returns the status of the article. |
| TestToggleTreePanel | Returns false if the article tree panel in Ted is collapsed, true if it is displayed. |
| ToggleAttributePanel Method | Toggles the article attribute panel in Ted. |
| ToggleCheck Method | Checks-out or checks-in the article. |
| ToggleSrc Method | Expands or collapses the source panel of the nIdx article element |
| ToggleTreePanel Method | Toggles the article tree panel in Ted. |
| Unlink Method | Unlinks the current article (texts and pictures). |
| Unlock Method | Unlocks the article. |
| Verify Method | Checks the article against the current schema. |
| Version Property | Returns the database version number of the article. |
| XML Method | The xml representation of the article (XmlNode object) |
By class
Basic
| Id Property | Returns the database identifier of the article. |
| Name Method | Returns or set the name of the article. |
| BasketId Property | Returns or set the database id of the basket the article is in. |
| Status Property | Returns the status of the article. |
| ToggleCheck Method | Checks-out or checks-in the article. |
| ToggleSrc Method | Expands or collapses the source panel of the nIdx article element |
| ToggleTreePanel Method | Toggles the article tree panel in Ted. |
| NTxts Property | Returns the number of texts contained in the article. |
Create, delete
| Spike Method | Spikes the article, closing its window. |
| Unlock Method | Unlocks the article. |
Open and close
| GotoNode Method | Edits the text of the specified node. |
| GotoNodeEx Method | Edits the text of the specified node in the specified mode. |
| GotoTxt Method | Edits the text of the specified node. |
| GotoTxtEx Method | Edits the specified text in the specified mode |
| CloseTxt Method | Terminates the editing of the specified text. |
Access and manipulate
| GetCurNode Method | Returns a node object corresponding to the element of the article that is selected in the tree window. |
| GetCurTxtIdx Method | Returns the index of the current text. |
| GetRootNode Method | Return a node object corresponding to the root element of the article - i.e. the whole article. |
| GetTxt Method | Return the text object of the nIdx text in the article. |
| GetTxtNode Method | Returns a node object corresponding to the specified text. |
Add and remove elements
| DelCurNode Method | Delete the current node (element) in the article tree window. |
| DelTxt Method | Deletes the specified text from the article. |
| InsChildNode Method | Insert a new child of the currently selected node. |
| InsNewTxt Method | Inserts a newly created text at the specified position in the article. |
| InsNodeAtCur Method | Insert a new node before or after the current one. |
| InsTxt Method | Inserts an existing text at the specified position in the article. |
| InsTxtDlg Method | Display dialog to select and insert an existing text at the specified position in the article. |
Templates and merge
| ApplyArticleTemplate Method | Applies a template article to the current article. |
| MergeFromArticle Method | Appends the data of an existing article into the current one. |
| DerivedDlg Method | Displays a dialog which lists all the articles copied to or from the current one |
Find and replace
| Find Method | Searches the current text for a string. |
| FindNext Method | Searches for the next match after a previous find command. |
| FindReplace Method | In the current text replaces str1 with str2, using options, specified in str3. |
| DoFindRepl Method | Displays a dialog to find and replace in an article |
Spelling
| GetSpellErrorNum Method | Return the number of spell checking errors in the article |
| SpellCheck Method | Checks spelling the entire article in the specified language. |
| SpellCheckDlg Method | Checks spelling in the entire article showing the dialog to choose the language. |
Objects and pictures
| CanInsObj Method | Returns true if it is possible to insert an object of the specified type in the article at the specified position. |
| GetObj Method | Return a reference object corresponding to the picture, multi-media or URL referenced by the specified text. |
| HasObj Method | Returns true if the specified text references an object (picture, multi-media or URL). |
| PictureBasketId Property | Returns or set the database id of the basket the picture is in. |
| SetReferenceDlg Method | Prompts the user to select a different referenced object (picture, multi-media or URL) for the specified text. |
| SetReferenceId Method | Replaces a referenced object with a specified one (by id). |
| InsObj Method | Inserts the object (picture etc.) of the specified type and id in the article at the specified position. |
| InsObjDlg Method | Display a dialog and inserts an object (picture, multi-media elements etc.) |
Attributes
| ToggleAttributePanel Method | Toggles the article attribute panel in Ted. |
Test elements
| IsChanged Property | Returns true if the article has been modified and not saved yet. |
| IsChecked Property | Returns true if the article is checked-out. |
| IsNew Property | Returns true if the article has not yet been saved in the database. |
| TestToggleTreePanel | Returns true if the Tree panel is displayed. |
| Verify Method | Checks the article against the current schema. |
Link
| LinkSelected Method | Links all the selected frames and pictures to the article. |
| Unlink Method | Unlinks the current article (texts and pictures). |
| PrintDraft Method | Prints the entire article in draft mode. |
Refresh
| Refresh Method | Reloads the article from the database. |
| RefreshGeometry Method | Reloads the geometry of all the article's text from the database. |
| Save Method | Saves the article. |
| SaveDlg Method | Displays a dialog box to save the article. |
| SaveTexts Method | Saves all article elements at once. |
| SelNode Method | Selects the specified node (element) in the article tree window. |
Versions
| Version Property | Returns the database version number of the article. |
XML
| XML Method | The xml representation of the article (XmlNode object) |
See also
Article call back functions