class GrabzIt::DOCXOptions

Represents all of the options available when creating a DOCX @version 3.1 @author GrabzIt

Public Class Methods

new() click to toggle source
Calls superclass method GrabzIt::BaseOptions::new
# File lib/grabzit/docxoptions.rb, line 8
def initialize()
        super()
        @includeBackground = true
        @pagesize = 'A4'
        @orientation = 'Portrait'
        @includeLinks = true
        @includeImages = true
        @title = nil
        @marginTop = 10
        @marginLeft = 10
        @marginBottom = 10
        @marginRight = 10
        @requestAs = 0
        @quality = -1
        @hideElement = nil
        @waitForElement = nil
        @noAds = false
        @browserWidth = nil
        @templateVariables = nil
        @width = nil
        @height = nil
        @templateId = nil
        @targetElement = nil
        @mergeId = nil
        @noCookieNotifications = false
        @address = nil
        @password = nil
        @clickElement = nil
end

Public Instance Methods

_getParameters(applicationKey, sig, callBackURL, dataName, dataValue) click to toggle source

@!visibility private

# File lib/grabzit/docxoptions.rb, line 409
def _getParameters(applicationKey, sig, callBackURL, dataName, dataValue)
        params = createParameters(applicationKey, sig, callBackURL, dataName, dataValue)             
        params['background'] = GrabzIt::Utility.b_to_str(@includeBackground)
        params['pagesize'] = @pagesize
        params['orientation'] = @orientation
        params['includelinks'] = GrabzIt::Utility.b_to_str(@includeLinks)
        params['includeimages'] = GrabzIt::Utility.b_to_str(@includeImages)
        params['title'] = GrabzIt::Utility.nil_check(@title)
        params['mleft'] = GrabzIt::Utility.nil_int_check(@marginLeft)
        params['mright'] = GrabzIt::Utility.nil_int_check(@marginRight)
        params['mtop'] = GrabzIt::Utility.nil_int_check(@marginTop)
        params['mbottom'] = GrabzIt::Utility.nil_int_check(@marginBottom)
        params['delay'] = GrabzIt::Utility.nil_int_check(@delay)
        params['requestmobileversion'] = GrabzIt::Utility.nil_int_check(@requestAs)          
        params['quality'] = GrabzIt::Utility.nil_int_check(@quality)
        params['hide'] = GrabzIt::Utility.nil_check(@hideElement)
        params['waitfor'] = GrabzIt::Utility.nil_check(@waitForElement)
        params['noads'] = GrabzIt::Utility.b_to_str(@noAds)
        params['post'] = GrabzIt::Utility.nil_check(@post)
        params['templateid'] = GrabzIt::Utility.nil_check(@templateId)
        params['target'] = GrabzIt::Utility.nil_check(@targetElement)
        params['bwidth'] = GrabzIt::Utility.nil_int_check(@browserWidth)
        params['width'] = GrabzIt::Utility.nil_int_check(@width)
        params['height'] = GrabzIt::Utility.nil_int_check(@height)
        params['tvars'] = GrabzIt::Utility.nil_check(@templateVariables)
        params['mergeid'] = GrabzIt::Utility.nil_check(@mergeId)
        params['address'] = GrabzIt::Utility.nil_check(@address)
        params['nonotify'] = GrabzIt::Utility.b_to_str(@noCookieNotifications)
        params['password'] = GrabzIt::Utility.nil_check(@password)
        params['click'] = GrabzIt::Utility.nil_check(@clickElement)
        
        return params;
end
_getSignatureString(applicationSecret, callBackURL, url = nil) click to toggle source

@!visibility private

# File lib/grabzit/docxoptions.rb, line 397
def _getSignatureString(applicationSecret, callBackURL, url = nil)
        items = [applicationSecret]
        
        if(url != nil)
                items.push(GrabzIt::Utility.nil_check(url))
        end
        
        items.push(GrabzIt::Utility.nil_check(callBackURL),GrabzIt::Utility.nil_check(@customId),GrabzIt::Utility.b_to_str(@includeBackground),@pagesize ,@orientation,GrabzIt::Utility.b_to_str(@includeImages),GrabzIt::Utility.b_to_str(@includeLinks),GrabzIt::Utility.nil_check(@title),GrabzIt::Utility.nil_int_check(@marginTop),GrabzIt::Utility.nil_int_check(@marginLeft),GrabzIt::Utility.nil_int_check(@marginBottom),GrabzIt::Utility.nil_int_check(@marginRight),GrabzIt::Utility.nil_int_check(@delay),GrabzIt::Utility.nil_int_check(@requestAs),GrabzIt::Utility.nil_check(@country),GrabzIt::Utility.nil_int_check(@quality),GrabzIt::Utility.nil_check(@hideElement),GrabzIt::Utility.nil_check(@exportURL),GrabzIt::Utility.nil_check(@waitForElement),GrabzIt::Utility.nil_check(@encryptionKey),GrabzIt::Utility.b_to_str(@noAds),GrabzIt::Utility.nil_check(@post),GrabzIt::Utility.nil_check(@targetElement),GrabzIt::Utility.nil_check(@templateId),GrabzIt::Utility.nil_check(@templateVariables),GrabzIt::Utility.nil_int_check(@height),GrabzIt::Utility.nil_int_check(@width),GrabzIt::Utility.nil_int_check(@browserWidth),GrabzIt::Utility.nil_check(@proxy),GrabzIt::Utility.nil_check(@mergeId),GrabzIt::Utility.nil_check(@address),GrabzIt::Utility.b_to_str(@noCookieNotifications),GrabzIt::Utility.nil_check(@password),GrabzIt::Utility.nil_check(@clickElement))
        return items.join("|")
end
add_post_parameter(name, value) click to toggle source

Define a HTTP Post parameter and optionally value, this method can be called multiple times to add multiple parameters. Using this method will force GrabzIt to perform a HTTP post.

@param name [String] the name of the HTTP Post parameter @param value [String] the value of the HTTP Post parameter

# File lib/grabzit/docxoptions.rb, line 384
def add_post_parameter(name, value)
        @post = appendParameter(@post, name, value)
end
add_template_parameter(name, value) click to toggle source

Define a custom template parameter and value, this method can be called multiple times to add multiple parameters.

@param name [String] the name of the template parameter @param value [String] the value of the template parameter

# File lib/grabzit/docxoptions.rb, line 392
def add_template_parameter(name, value)
        @templateVariables = appendParameter(@templateVariables, name, value)
end
address() click to toggle source

@return [String] get the URL to execute the HTML code in

# File lib/grabzit/docxoptions.rb, line 354
def address
        @address
end
address=(value) click to toggle source

Set the URL to execute the HTML code in

@param value [String] the address @return [void]

# File lib/grabzit/docxoptions.rb, line 362
def address=(value)
        @address = value
end
browserWidth() click to toggle source

@return [Integer] the width of the browser in pixels

# File lib/grabzit/docxoptions.rb, line 171
def browserWidth
        @browserWidth
end
browserWidth=(value) click to toggle source

Set the width of the browser in pixels

@param value [Integer] the browser width @return [void]

# File lib/grabzit/docxoptions.rb, line 179
def browserWidth=(value)
        @browserWidth = value
end
clickElement() click to toggle source

@return [String] get the CSS selector of the HTML element in the web page that must clicked before the capture is performed

# File lib/grabzit/docxoptions.rb, line 301
def clickElement
        @clickElement
end
clickElement=(value) click to toggle source

Set the CSS selector of the HTML element in the web page that must clicked before the capture is performed

@param value [String] the element to click @return [void]

# File lib/grabzit/docxoptions.rb, line 309
def clickElement=(value)
        @clickElement = value
end
delay() click to toggle source

@return [Integer] the number of milliseconds to wait before creating the capture

# File lib/grabzit/docxoptions.rb, line 210
def delay
        @delay
end
delay=(value) click to toggle source

Set the number of milliseconds to wait before creating the capture

@param value [Integer] delay @return [void]

# File lib/grabzit/docxoptions.rb, line 218
def delay=(value)
        @delay = value
end
hideElement() click to toggle source

@return [String] get the CSS selector(s) of the one or more HTML elements in the web page to hide

# File lib/grabzit/docxoptions.rb, line 275
def hideElement
        @hideElement
end
hideElement=(value) click to toggle source

Set the CSS selector(s) of the one or more HTML elements in the web page to hide

@param value [String] the element(s) to hide @return [void]

# File lib/grabzit/docxoptions.rb, line 283
def hideElement=(value)
        @hideElement = value
end
includeBackground() click to toggle source

@return [Boolean] true if the background images of the web page should be included in the DOCX

# File lib/grabzit/docxoptions.rb, line 39
def includeBackground
        @includeBackground
end
includeBackground=(value) click to toggle source

Set to true if the background images of the web page should be included in the DOCX

@param value [Boolean] include background images @return [void]

# File lib/grabzit/docxoptions.rb, line 47
def includeBackground=(value)
        @includeBackground = value
end
includeImages() click to toggle source

@return [Boolean] true if web page images should be included

# File lib/grabzit/docxoptions.rb, line 93
def includeImages
        @includeImages
end
includeImages=(value) click to toggle source

Set to true if web page images should be included

@param value [Boolean] include images @return [void]

# File lib/grabzit/docxoptions.rb, line 101
def includeImages=(value)
        @includeImages = value
end
marginBottom() click to toggle source

@return [Integer] the margin that should appear at the bottom of the DOCX document page

# File lib/grabzit/docxoptions.rb, line 145
def marginBottom
        @marginBottom
end
marginBottom=(value) click to toggle source

Set the margin that should appear at the bottom of the DOCX document page

@param value [Integer] margin bottom @return [void]

# File lib/grabzit/docxoptions.rb, line 153
def marginBottom=(value)
        @marginBottom = value
end
marginLeft() click to toggle source

@return [Integer] the margin that should appear at the left of the DOCX document page

# File lib/grabzit/docxoptions.rb, line 132
def marginLeft
        @marginLeft
end
marginLeft=(value) click to toggle source

Set the margin that should appear at the left of the DOCX document page

@param value [Integer] margin left @return [void]

# File lib/grabzit/docxoptions.rb, line 140
def marginLeft=(value)
        @marginLeft = value
end
marginRight() click to toggle source

@return [Integer] the margin that should appear at the right of the DOCX document

# File lib/grabzit/docxoptions.rb, line 158
def marginRight
        @marginRight
end
marginRight=(value) click to toggle source

Set the margin that should appear at the right of the DOCX document

@param value [Integer] margin right @return [void]

# File lib/grabzit/docxoptions.rb, line 166
def marginRight=(value)
        @marginRight = value
end
marginTop() click to toggle source

@return [Integer] the margin that should appear at the top of the DOCX document page

# File lib/grabzit/docxoptions.rb, line 119
def marginTop
        @marginTop
end
marginTop=(value) click to toggle source

Set the margin that should appear at the top of the DOCX document page

@param value [Integer] margin top @return [void]

# File lib/grabzit/docxoptions.rb, line 127
def marginTop=(value)
        @marginTop = value
end
mergeId() click to toggle source

@return [String] get the ID of a capture that should be merged at the beginning of the new DOCX document

# File lib/grabzit/docxoptions.rb, line 314
def mergeId
        @mergeId
end
mergeId=(value) click to toggle source

Set the ID of a capture that should be merged at the beginning of the new DOCX document

@param value [String] the merge ID @return [void]

# File lib/grabzit/docxoptions.rb, line 322
def mergeId=(value)
        @mergeId = value
end
noAds() click to toggle source

@return [Boolean] get if adverts should be automatically hidden

# File lib/grabzit/docxoptions.rb, line 327
def noAds
        @noAds
end
noAds=(value) click to toggle source

Set to true if adverts should be automatically hidden

@param value [Boolean] hide adverts @return [void]

# File lib/grabzit/docxoptions.rb, line 335
def noAds=(value)
        @noAds = value
end
noCookieNotifications() click to toggle source

@return [Boolean] get if cookie notifications should be automatically hidden

# File lib/grabzit/docxoptions.rb, line 341
def noCookieNotifications
        @noCookieNotifications
end
noCookieNotifications=(value) click to toggle source

Set to true if cookie notifications should be automatically hidden

@param value [Boolean] hide cookie notifications @return [void]

# File lib/grabzit/docxoptions.rb, line 349
def noCookieNotifications=(value)
        @noCookieNotifications = value
end
orientation() click to toggle source

@return [String] the orientation of the DOCX to be returned

# File lib/grabzit/docxoptions.rb, line 66
def orientation
        @orientation
end
orientation=(value) click to toggle source

Set the orientation of the DOCX to be returned: 'Landscape' or 'Portrait'

@param value [String] page orientation @return [void]

# File lib/grabzit/docxoptions.rb, line 74
def orientation=(value)
        value = GrabzIt::Utility.nil_check(value).capitalize
        @orientation = value
end
pageHeight() click to toggle source

@return [Integer] get the page height of the resulting DOCX in mm

# File lib/grabzit/docxoptions.rb, line 197
def pageHeight
        @height
end
pageHeight=(value) click to toggle source

Set the page height of the resulting DOCX in mm

@param value [Integer] the height @return [void]

# File lib/grabzit/docxoptions.rb, line 205
def pageHeight=(value)
        @height = value
end
pageWidth() click to toggle source

@return [Integer] get the page width of the resulting DOCX in mm.

# File lib/grabzit/docxoptions.rb, line 184
def pageWidth
        @width
end
pageWidth=(value) click to toggle source

Set the page width of the resulting DOCX in mm

@param value [Integer] the width @return [void]

# File lib/grabzit/docxoptions.rb, line 192
def pageWidth=(value)
        @width = value
end
pagesize() click to toggle source

@return [String] the page size of the DOCX to be returned

# File lib/grabzit/docxoptions.rb, line 52
def pagesize
        @pagesize
end
pagesize=(value) click to toggle source

Set the page size of the DOCX to be returned: 'A3', 'A4', 'A5', 'A6', 'B3', 'B4', 'B5', 'B6', 'Letter'

@param value [String] page size @return [void]

# File lib/grabzit/docxoptions.rb, line 60
def pagesize=(value)
        value = GrabzIt::Utility.nil_check(value).upcase
        @pagesize = value
end
password() click to toggle source

@return [String] get the password that protects the DOCX document

# File lib/grabzit/docxoptions.rb, line 367
def password
        @password
end
password=(value) click to toggle source

Set the password that protects the DOCX document

@param value [String] the password @return [void]

# File lib/grabzit/docxoptions.rb, line 375
def password=(value)
        @password = value
end
quality() click to toggle source

@return [Integer] the quality of the DOCX.

# File lib/grabzit/docxoptions.rb, line 249
def quality
        @quality
end
quality=(value) click to toggle source

Set the quality of the DOCX where 0 is poor and 100 excellent. The default is -1 which uses the recommended quality

@param value [Integer] quality @return [void]

# File lib/grabzit/docxoptions.rb, line 257
def quality=(value)
        @quality = value
end
requestAs() click to toggle source

@return [Integer] get which user agent type should be used

# File lib/grabzit/docxoptions.rb, line 223
def requestAs
        @requestAs
end
requestAs=(value) click to toggle source

Set which user agent type should be used: Standard Browser = 0, Mobile Browser = 1, Search Engine = 2 and Fallback Browser = 3

@param value [Integer] the browser type @return [void]

# File lib/grabzit/docxoptions.rb, line 231
def requestAs=(value)
        @requestAs = value
end
targetElement() click to toggle source

@return [String] get the CSS selector of the only HTML element in the web page to capture

# File lib/grabzit/docxoptions.rb, line 262
def targetElement
        @targetElement
end
targetElement=(value) click to toggle source

Set the CSS selector of the only HTML element in the web page to capture

@param value [String] the target element @return [void]

# File lib/grabzit/docxoptions.rb, line 270
def targetElement=(value)
        @targetElement = value
end
templateId() click to toggle source

@return [String] the template ID that specifies the header and footer of the DOCX document

# File lib/grabzit/docxoptions.rb, line 236
def templateId
        @templateId
end
templateId=(value) click to toggle source

Set a template ID that specifies the header and footer of the DOCX document

@param value [String] template id @return [void]

# File lib/grabzit/docxoptions.rb, line 244
def templateId=(value)
        @templateId = value
end
title() click to toggle source

@return [String] a title for the DOCX document

# File lib/grabzit/docxoptions.rb, line 106
def title
        @title
end
title=(value) click to toggle source

Set a title for the DOCX document

@param value [String] DOCX title @return [void]

# File lib/grabzit/docxoptions.rb, line 114
def title=(value)
        @title = value
end
waitForElement() click to toggle source

@return [String] get the CSS selector of the HTML element in the web page that must be visible before the capture is performed

# File lib/grabzit/docxoptions.rb, line 288
def waitForElement
        @waitForElement
end
waitForElement=(value) click to toggle source

Set the CSS selector of the HTML element in the web page that must be visible before the capture is performed

@param value [String] the element to wait for @return [void]

# File lib/grabzit/docxoptions.rb, line 296
def waitForElement=(value)
        @waitForElement = value
end