General XMetaL Discussion

XMetaL Community Forum General XMetaL Discussion XMAX Full API Documentation for version 6 and 7

  • MrPaul

    XMAX Full API Documentation for version 6 and 7

    Participants 2
    Replies 3
    Last Activity 9 years, 6 months ago

    Hi,

    Where can I find the full API documentation for XMAX version 6 (which we are currently using) and for version 7 (so we can see what's available and compare it before we upgrade)?

    Thank you.

    Reply

    Derek Read

    Reply to: XMAX Full API Documentation for version 6 and 7

    APIs are documented in the Programmers Guide that comes with XMetaL Developer.

    The readme file that comes with XMAX 7.0 lists the following APIs as being new to that release. Many of these allow you to change settings that are normally controlled in XMetaL Author using INI settings (and in some cases exposed through the XMetaL Author UI). XMAX does not support an INI file but we were getting various requests for the ability to change some settings so some selected settings have now been implemented as APIs.

    API Description
    IXMetaLControl.SaveWithDoctypeDeclaration When set to NO the doctype declaration is omitted from the saved file. Files that contain a doctype declaration when opened have the doctype declaration stripped from them.
    IXMetaLControl.SaveWithSGMLDeclaration Tells XMAX to whether or not to write out the SGML declaration whenever Save() is called.
    IXMetaLControl.NormalizeImagesURLsOnSave Automatically adjust all Treat As Image source attribute values in relation to the saved document's file location.
    IXMetaLControl.NormalizeXMLBaseURLsOnSave Automatically adjust all xml:base href attribute.
    IXMetaLControl.NormalizeXMLBaseURLsOnSave Automatically adjust all xi:include href attributes.
    IXMetaLControl.NormalizeSystemIdURLsOnSave Set to true (default): XMAX changes the SYSTEM URL (path to the DTD) in the Doctype Declaration to a path relative to the location of the XML file. Set to false: The path is left unaltered (i.e., the value it was when the XML file was first loaded).
    IXMetaLControl.XmlOpenAsWellFormed Intended to be used in conjunction with Xml startup of XMAX in a webpage to indicate a well-formed open is desired.
    IXMetaLControl.EmptyElementGifPath Image displayed for an empty element in Tags On and Normal views.
    IXMetaLControl.MissingImageGifPath Image displayed when images isn't found or href is unset while in Tags On and Normal views.
    IXMetaLControl.TagsOnViewTagFontName Typeface used for tag icons.
    IXMetaLControl.TagsOnViewTagFontSize Font size used for tag icons.
    IXMetaLControl.TagsOnViewTagBackgroundColor Background color for tag icons.
    IXMetaLControl.TagsOnViewTagColor Text and outline color for tag icons.
    IXMetaLControl.TagsOnViewReducedTagsMode Show tags without element names inside them.
    IXMetaLControl.TagsOnViewShowComments Show XML comments in Tags On view.
    IXMetaLControl.ShowInlineImages Visibility of tag tips in Tags On view.
    IXMetaLControl.TagsOnViewShowTagTips Visibility of tag tips in Tags On view.
    IXMetaLControl.TagsOnViewTagTipsWithFixedAttributes Visibility of fixed/defaulted attribute values in tag tips in Tags On view.
    IXMetaLControl.TagsOnViewGraphicalTables Hide table markup in Tags On view.
    IXMetaLControl.EnableCALSTableAutoLayout If enabled, ignores width attributes so you can see all of cells content (i.e. columns auto-widen).
    IXMetaLControl.DrawGridOnBorderlessTable Draw a dotted line around table cells when the border value is set to 0.
    IXMetaLControl.TrackRevisionsUserName Name used for change tracking. If no name is specified, the default Windows login user name is used.
    IXMetaLControl.PlainTextViewFontName Font used in Plain Text view.
    IXMetaLControl.PlainTextViewFontSize Size of the font used in Plain Text view.
    IXMetaLControl.PlainTextViewAutoIndent Auto-indent text after typing a carriage-return.
    IXMetaLControl.PlainTextViewNoWrapInTags Do not wrap text inside tags even if exceeding CTM maxlinelength.
    IXMetaLControl.PlainTextViewExpandTabsOnSave Convert all tabs (ASCII 0x09) characters into spaces (ASCII 0x20) upon Save() call.
    IXMetaLControl.PlainTextViewShowLineNumbering Display line numbering in source view on left-hand side.
    IXMetaLControl.PlainTextViewTabSize Width in spaces of a tab character in Plain Text view.
    IXMetaLControl.PlainTextViewShowTabs Display tabs in source view.
    IXMetaLControl.PlainTextViewWrapLines Wrap lines in source view. 0 = Off; 1 = Break within words; 2 = Break between words.
    Document.InlineMediaVisible Visibility of images and OCXReplacements, i.e. Hide/Show Inline Images state.
    Document.msgHwnd Current MSG.hwnd. Only valid to call during On_Application_View_Event.
    Document.msgMessage Current MSG.message. Only valid to call during On_Application_View_Event.
    Document.msgWParam Current MSG.wParam. Only valid to call during On_Application_View_Event.
    Document.msgLParam Current MSG.lParam. Only valid to call during On_Application_View_Event.
    Document.msgTime Current MSG.time. Only valid to call during On_Application_View_Event.
    Document.msgX Current MSG.pt.x. Only valid to call during On_Application_View_Event.
    Document.msgY Current MSG.pt.y. Only valid to call during On_Application_View_Event.
    Document.WindowHandle Document view HWND. Only valid to obtain when in Plain Text, Tags On, and Normal view-modes.
    Document.RangeNearestPoint Return Range object set as if mouse was pressed at the given screen coordinates. If no coordinates provided, current mouse position is used. If no Range, point was outside of window.
    Document.BeginMutations Signal start of a group of document mutations to be treated as a single undo-able action. Only valid for Tags On and Normal view-modes.
    Document.EndMutations Signal end of a group of document mutations to be treated as a single undo-able action. Only valid for Tags On and Normal view-modes.
    Document.GetNodeSpellLanguage Get node's spelling language.
    Document.IsDummyNode Returns true if the node is a dummy node.
    Document.HighlightRange Highlight a specified range of a document.
    Document.SetHighlightedRangeState Set status properties on a highlighted range.
    Document.GetHighlightedRange Get Highlighted Range by id.
    Document.ScrollSelectionToTop Scrolls selection to top of the view.
    Document.ScrollSelectionToBottom Scrolls selection to bottom of the view.
    Selection.screenTop Return TOP screen coordinate of current selection rect indicated.
    Selection.screenLeft Return LEFT screen coordinate of current selection rect indicated.
    Selection.screenBottom Return BOTTOM screen coordinate of current selection rect indicated.
    Selection.screenRight Return RIGHT screen coordinate of current selection rect indicated.
    Selection.IsPointInside Return true if screen coordinate is within the Range on-screen selection rect.
    Selection.SelectNodeContentsAt Moves this selection to be the content of the specified DOMNode at specified position.
    Selection.SelectionLocation Get/set the selection location in format ;;.
    Customizations.ElementPropList Returns an object for the Element Properties.
    ElementProps.Item Returns an element property item. Index ranges from 0 to Count 1.
    ElementProps.Count Returns the number of element property items.
    ElementProp.Name Returns the element name of the element property.
    ElementProp.LongDescription Returns the long description of the element property.
    ElementProp.ShortDescription Returns the short description of the element property.

    Reply

    MrPaul

    Reply to: XMAX Full API Documentation for version 6 and 7

    Document.InlineMediaVisible is also present in the readme of version 6 under new APIs (with the exact same description). What's changed in version 7? How would we set this in .NET using the AxXMetaLControlLib.AxXMetaLControl object? In VB6, we seem to be able to access it but it's read only. So how do we set it?

    Thanks.

    Reply

    Derek Read

    Reply to: XMAX Full API Documentation for version 6 and 7

    That property is in fact read only.

    Maybe what you are looking for is IXMetaLControl.ShowInlineImages ?
    I see that the description in the readme is incorrect (which I copied in my posting). It should probably say something like “Show (or hide) inline images.”

    That API provides the ability to do the same thing as the menu item named “Hide Inline Images” (or “Show Inline Images” if they are already hidden) on the View menu in XMetaL Author.

    Reply

  • You must be logged in to reply to this topic.

Lost Your Password?

Products
Downloads
Support